en-US/Ravello-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> <!-- Module: Ravello Version: 1.1.2.5 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-RavelloApplicationVm</command:name> <maml:description> <maml:para>Adds a new VM to an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RavelloApplicationVm</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>The cmdlet adds a new VM to a Ravello Application. The VM is defined by it's Name or ID. A new VmName and/or Description can be passed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmDescription</maml:name> <maml:description> <maml:para>The new description of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmDescription</maml:name> <maml:description> <maml:para>The new description of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmDescription</maml:name> <maml:description> <maml:para>The new description of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmDescription</maml:name> <maml:description> <maml:para>The new description of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmDescription</maml:name> <maml:description> <maml:para>The new description of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App | Add-RavelloApplicationVm -ImageName Empty -NewVmName Server1</dev:code> <dev:remarks> <maml:para>A VM, called Empty, from the VM Libarary is added to the Application called App. The VM will be renamed to Server1 in the Application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-RavelloApplicationVm -ApplicationId 12345678 -ImageId 456789 -NewVMName NewVM</dev:code> <dev:remarks> <maml:para>A VM, identified by it's Id, is added to an Application, identified by it's Id. The VM will be named NewVM in the application.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Ravello REST API Documentation</maml:linkText> <maml:uri>http://www.ravellosystems.com/developers/rest-api</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-RavelloPermissionsGroupUser</command:name> <maml:description> <maml:para>Add a User to a Permission Group</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RavelloPermissionsGroupUser</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Add a User to a Permission Group. The User must be in the Organization where the Permission Group is defined.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-RavelloPermissionsGroupUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RavelloPermissionsGroupUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RavelloPermissionsGroupUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RavelloPermissionsGroupUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-RavelloPermissionsGroupUser -PermissionGroupName Group1 -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>The example will add user "John Doe" to Permission Group Group1. User "John Doe" needs to be in the Organization where the Permission Group is defined. Check with Get-RavelloOrganization -Users</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloPermissionsGroup -PermissionsGroupName Group2 | Add-RavelloPermissionsGroupUser -UserId 12345678</dev:code> <dev:remarks> <maml:para>The script add a user with the Id 12345678 to the PermissionsGroup called Group2</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Connect-Ravello</command:name> <maml:description> <maml:para>Login to the Ravello environment</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>Ravello</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Login to the Ravello environment. Use the account by which you subscribed to Ravello.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Connect-Ravello</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A [System.Management.Automation.PSCredential] object that holds the user and password of the Ravello account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Proxy</maml:name> <maml:description> <maml:para>If you access Ravello from behind a proxy, provide the URL of the proxy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fiddler</maml:name> <maml:description> <maml:para>Switch to redirect REST calls to the local Fiddler application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-Ravello</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>The Ravello user account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the Ravello user account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Proxy</maml:name> <maml:description> <maml:para>If you access Ravello from behind a proxy, provide the URL of the proxy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fiddler</maml:name> <maml:description> <maml:para>Switch to redirect REST calls to the local Fiddler application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A [System.Management.Automation.PSCredential] object that holds the user and password of the Ravello account.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Proxy</maml:name> <maml:description> <maml:para>If you access Ravello from behind a proxy, provide the URL of the proxy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fiddler</maml:name> <maml:description> <maml:para>Switch to redirect REST calls to the local Fiddler application</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>The Ravello user account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the Ravello user account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Connect-Ravello -User 'me@domain.com' -Password 'MyPassword'</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$cred = Get-Credential -Message 'Ravello account' Connect-Ravello -Credential $cred -Proxy 'http://proxy.domain.com:8080'</dev:code> <dev:remarks> <maml:para>Connect with an account that is stored in a System.Management.Automation.PSCredential object, and specify the proxy address.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$cred = Get-Credential -Message 'Ravello account' Connect-Ravello -Credential $cred -Fiddler</dev:code> <dev:remarks> <maml:para>Connect with an account that is stored in a System.Management.Automation.PSCredential object. Due to the Fiddler switch, all REST calls will be redirected to the Fiddler application.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Copy-RavelloRepoBlueprint</command:name> <maml:description> <maml:para>Copy a Blueprint from a Repository</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>RavelloRepoBlueprint</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a copy of a Blueprint located in a Repository to your Blueprint library.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Copy-RavelloRepoBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewBlueprintName</maml:name> <maml:description> <maml:para>The new Name of the Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-RavelloRepoBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewBlueprintName</maml:name> <maml:description> <maml:para>The new Name of the Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewBlueprintName</maml:name> <maml:description> <maml:para>The new Name of the Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Copy-RavelloRepoBlueprint -BlueprintName bp-sql-srv -NewBlueprintName SqlSrv -Description 'SQL server setup'</dev:code> <dev:remarks> <maml:para>Create a copy of the Blueprint, called bp-sql-srv. The new Blueprint is named SqlSrv, and has the Description 'SQL Server setup'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Copy-RavelloRepoDisk</command:name> <maml:description> <maml:para>Copy a Disk from a Repository</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>RavelloRepoDisk</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a copy of a Disk Image located in a Repository to your Disk library.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Copy-RavelloRepoDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-RavelloRepoDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Copy-RavelloRepoDisk -DiskName centos-6 -NewDiskName cent6-copy -Description 'CentOS v6'</dev:code> <dev:remarks> <maml:para>Create a copy of the Disk Image, called centos-6. The new Disk Image is named cent6-copy, and has the Description 'CentOS v6'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Copy-RavelloRepoVm</command:name> <maml:description> <maml:para>Copy a VM from a Repository</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>RavelloRepoVm</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a copy of a VM located in a Repository to your VM library.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Copy-RavelloRepoVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-RavelloRepoVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewVmName</maml:name> <maml:description> <maml:para>The new Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name 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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Copy-RavelloRepoVm -VmName FreeNas-01-REPO -NewVmName 'Copy FreeNAS' -Description 'Copy of FreeNAS'</dev:code> <dev:remarks> <maml:para>Create a copy of the VM, called FreeNas-01-REPO. The new Disk Image is named 'Copy FreeNAS', and has the Description 'Copy of FreeNAS'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disable-RavelloUser</command:name> <maml:description> <maml:para>Disable a User</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>RavelloUser</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Disable a User. The User will not be removed from the Organization, but the User will not be able to connect to the Organization anymore.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Disable-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-RavelloUser -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>Disables the account associated with User John Doe</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUser -UserId 12345678 | Disable-RavelloUser</dev:code> <dev:remarks> <maml:para>Disables the User with UserId 12345678</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disconnect-Ravello</command:name> <maml:description> <maml:para>Disconnect the open Ravello session</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>Ravello</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Disconnect from the active Ravello session</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disconnect-Ravello</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disconnect-Ravello</dev:code> <dev:remarks> <maml:para>Disconnect the open Ravello session</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Enable-RavelloUser</command:name> <maml:description> <maml:para>Enable a User</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>RavelloUser</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Enables a User that was previously disabled.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-RavelloUser -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>Enable the User called John Doe</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUser -FirstName John -LastName Doe | Enable-RavelloUser</dev:code> <dev:remarks> <maml:para>Enable the User called John Doe</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplication</command:name> <maml:description> <maml:para>Get an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplication</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get a one or more Applications under the authenticated User’s Organization. The cmdlet can return the full Application object, or the Design, Deployment or basic Properties. When the Name or ID of a VM in the Application is specified, the cmdlet will return the VM object.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>Switch to return information on how the Application was deployed in the cloud</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>Switch to return information on how the Application was designed by the user</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>Switch to return information on how the Application was deployed in the cloud</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>Switch to return information on how the Application was designed by the user</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>Switch to return information on how the Application was deployed in the cloud</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>Switch to return information on how the Application was designed by the user</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication</dev:code> <dev:remarks> <maml:para>Return all the Applications in the Organization</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App1</dev:code> <dev:remarks> <maml:para>Return the object for the Application, called App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App1 -Deployment</dev:code> <dev:remarks> <maml:para>Return the Deployment properties for the Application, called App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationCharge</command:name> <maml:description> <maml:para>Get the Application charges</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationCharge</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get the detailed charges for the Application. Prices are in USD The pricing can be retrieved based on the Design or on the Deployment.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationCharge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Optimization</maml:name> <maml:description> <maml:para>The level of Optimzation for the Application Possible values are PERFORMANCE_OPTIMIZED and COST_OPTIMIZED</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cloud</maml:name> <maml:description> <maml:para>The Cloud used to calculate the prices. Possible values are AMAZON and GOOGLE</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The Region used to calculate the price. Possible values are 'Virginia','Oregon','Northern California','Ireland','Singapore','Frankfurt', 'Sydney','Tokyo','SaoPaulo (AMAZON)','us-central1','europe-west1','asia-east1 (GOOGLE)'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationCharge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationCharge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="name"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Optimization</maml:name> <maml:description> <maml:para>The level of Optimzation for the Application Possible values are PERFORMANCE_OPTIMIZED and COST_OPTIMIZED</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cloud</maml:name> <maml:description> <maml:para>The Cloud used to calculate the prices. Possible values are AMAZON and GOOGLE</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The Region used to calculate the price. Possible values are 'Virginia','Oregon','Northern California','Ireland','Singapore','Frankfurt', 'Sydney','Tokyo','SaoPaulo (AMAZON)','us-central1','europe-west1','asia-east1 (GOOGLE)'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationCharge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="name"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Optimization</maml:name> <maml:description> <maml:para>The level of Optimzation for the Application Possible values are PERFORMANCE_OPTIMIZED and COST_OPTIMIZED</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cloud</maml:name> <maml:description> <maml:para>The Cloud used to calculate the prices. Possible values are AMAZON and GOOGLE</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The Region used to calculate the price. Possible values are 'Virginia','Oregon','Northern California','Ireland','Singapore','Frankfurt', 'Sydney','Tokyo','SaoPaulo (AMAZON)','us-central1','europe-west1','asia-east1 (GOOGLE)'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="name"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationCharge -ApplicationName App1</dev:code> <dev:remarks> <maml:para>Returns the detailed charges for the Application, called App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationCharge -ApplicationName App1 -Deployment</dev:code> <dev:remarks> <maml:para>Returns the pricing according to the deployed VMs in the Cloud</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationCharge -ApplicationName App1 -Optimization COST_OPTIMIZED -Cloud GOOGLE</dev:code> <dev:remarks> <maml:para>Returns the detailed charges for the Application, called App1, when deployed for Cost Optimization and in the GOOGLE cloud.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationDocumentation</command:name> <maml:description> <maml:para>Get the Documentation for the Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Documentation for the Application. The Documentation is in Markdown format</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationDocumentation -ApplicationName App1</dev:code> <dev:remarks> <maml:para>Returns the Documentation, in Markdown format, for the Application, called App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App1 | Get-RavelloApplicationDocumentation</dev:code> <dev:remarks> <maml:para>Returns the Documentation, in Markdown format, for the Application, called App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationPublishLocation</command:name> <maml:description> <maml:para>Get the publish locations for an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationPublishLocation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get all the possible publish locations for the given Application</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationPublishLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PreferredCloud</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PreferredCloud</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationPublishLocation -ApplicationName App1</dev:code> <dev:remarks> <maml:para>Get the possible publish locations for an Application, called App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationVm</command:name> <maml:description> <maml:para>Get a VM from an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationVm</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the VM object. The VM is part of the Application. The Design and Deployment switches, define whic</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Deployment information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Design information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Deployment information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Design information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Deployment information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Design information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Deployment information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Design information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Deployment information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Design information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Deployment information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Design information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deployment</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Deployment information</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Design</maml:name> <maml:description> <maml:para>The returned VM object will hold detailed Design information</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationVm -ApplicationName App1 -VmName Srv1</dev:code> <dev:remarks> <maml:para>An object containing information about the VM, called Srv1, from the Application, called App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App1 | Get-RavelloApplicationVM -VmId 12345678 -Deployment</dev:code> <dev:remarks> <maml:para>The returned object contains Deployment information for a VM, called SRV1, in Application, called App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationVm -ApplicationName App1</dev:code> <dev:remarks> <maml:para>Returns all the VMs present in Application App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationVmFqdn</command:name> <maml:description> <maml:para>Get the FQDN of a VM</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationVmFqdn</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Fully Qualified Domain Name of the public IP of a VM in an Application. The Application needs to be deployed</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmFqdn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmFqdn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmFqdn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmFqdn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationVmFqdn -ApplicationName App1 -VmName Srv1</dev:code> <dev:remarks> <maml:para>Returns the FQDN of the VM, called Srv1, in the Application, called App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationVmIso</command:name> <maml:description> <maml:para>Get the Disk Image conencted to A vm</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationVmIso</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Return the Disk Image that is connected to a VM in a specific Application</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application to which you want to attach the ISO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the Device where the ISO is mounted</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="id"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application to which you want to attach the ISO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the Device where the ISO is mounted</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application to which you want to attach the ISO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the Device where the ISO is mounted</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="id"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application to which you want to attach the ISO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the Device where the ISO is mounted</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application to which you want to attach the ISO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the Device where the ISO is mounted</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>cdrom</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="id"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application to which you want to attach the ISO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationVmIso -ApplicationName App1 -VmName Srv1</dev:code> <dev:remarks> <maml:para>Get the Disk Image that is mounted on a VM, called Srv1, in an Application, called App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationVmPublicIp</command:name> <maml:description> <maml:para>Get the public IP address of the VM</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationVmPublicIp</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the public IP address of the VM in the Application. The Application needs to be deployed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmPublicIp</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmPublicIp</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmPublicIp</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmPublicIp</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationVmPublicIp -ApplicationName App1 -VmName Srv1</dev:code> <dev:remarks> <maml:para>Returns the public IP address of the VN, called Srv1, in the Application, called App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationVmState</command:name> <maml:description> <maml:para>Get the Cloud status of a deployed VM</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationVmState</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Cloud status of a deployed VM. The possible values for the Cloud status are: PUBLISHING, WAITING_TO_START, STARTING, STARTED, RESTARTING, RESETTING_DISKS, WAITING_TO_STOP, STOPPING, STOPPED, TERMINATING, TERMINATED, ERROR, UNKNOWN, UPDATING, REPAIRING, ERROR_DEPLOY, ERROR_TERMINATE.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The name of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM in the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title>Only for Deployed VMs</maml:title> <maml:alert> <maml:para>The Cloud status can only be queried for a Deployed VM</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationVmState -ApplicationName App1 -VmName Srv1</dev:code> <dev:remarks> <maml:para>Returns the Cloud status of the VM, named Srv1, in the Application, named App1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloApplicationVmVnc</command:name> <maml:description> <maml:para>Get the VM's VNC URL</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloApplicationVmVnc</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get the URL to the VNC console for the VM in a specific Application.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmVnc</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmVnc</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmVnc</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloApplicationVmVnc</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplicationVmVnc -ApplicationName App1 -VmName Srv1</dev:code> <dev:remarks> <maml:para>Returns the URL to connect to a VNC session with the VM, called Srv1, in an Application, called App1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$url = Get-RavelloApplicationVmVnc -ApplicationName App1 -VmName Srv1 Start-Process -FilePath $url</dev:code> <dev:remarks> <maml:para>The URL to the VNC console is saved in a variable, and then the URL is opened with the default browser.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloBilling</command:name> <maml:description> <maml:para>Get the Ravello Billing details</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloBilling</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Return the Ravello Billing details for a specific Month in a specific Year.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloBilling</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Year</maml:name> <maml:description> <maml:para>The year in the format yyyy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Month</maml:name> <maml:description> <maml:para>The month expressed as an int (1-12)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Year</maml:name> <maml:description> <maml:para>The year in the format yyyy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Month</maml:name> <maml:description> <maml:para>The month expressed as an int (1-12)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <maml:alertSet> <!--Notes--> <maml:title>vExpert accounts</maml:title> <maml:alert> <maml:para>Please note that since there is no billing for vExperts account, this cmdlet will not return any information for such an account.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloBilling -Year 2015 -Month 7</dev:code> <dev:remarks> <maml:para>Returns the billing information for July 2015.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloBlueprint</command:name> <maml:description> <maml:para>Get the Blueprint(s) Get-RavelloBlueprint -BlueprintId <long> [<CommonParameters>] Get-RavelloBlueprint -Name <string> [<CommonParameters>] Get-RavelloBlueprint -Private [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloBlueprint</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get one or more Blueprints. When no specific Blueprint is requested, the returned objects only have some general properties. When a specific Blueprint is requested (BlueprintName or BlueprintId), an object with detailed properties is returned. With the Private switch, only the Blueprints that belong to the user;s Organization are returned.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloBlueprint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>When set, only Blueprints that belong to the User's Organization are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>When set, only Blueprints that belong to the User's Organization are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>When set, only Blueprints that belong to the User's Organization are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>When set, only Blueprints that belong to the User's Organization are returned.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloBlueprint</dev:code> <dev:remarks> <maml:para>Returns all Blueprint, public and private. The objects do not have the full information present.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloBlueprint -BlueprintName BP1</dev:code> <dev:remarks> <maml:para>Returns an object representing a Blueprint, called BP1. The object has all available properties.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloBlueprintDocumentation</command:name> <maml:description> <maml:para>Get the Blueprint Documentation</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloBlueprintDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Documentation for the Blueprint. The Documentation is in Markdown format</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloBlueprintDocumentation -BlueprintId 12345678</dev:code> <dev:remarks> <maml:para>Returns the documentation associated with a Blueprint, that has the id 12345678</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloBlueprintPublishLocation</command:name> <maml:description> <maml:para>Get the publish locations for a Blueprint</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloBlueprintPublishLocation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns all the possible publish locations for the application that will be created from this blueprint, considering the storage and CPU needs. The list is sorted by costs – low to high.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloBlueprintPublishLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloBlueprintPublishLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloBlueprintPublishLocation -BlueprintName BP1</dev:code> <dev:remarks> <maml:para>Returns all the possible publish locations for Blueprint BP1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloCommunity</command:name> <maml:description> <maml:para>Get the Ravello Community</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloCommunity</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get the known Ravello Communities, or get an object representing a specific Community.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloCommunity</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloCommunity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloCommunity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloCommunity</dev:code> <dev:remarks> <maml:para>Returns all known Commuities</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloCommunity -CommunityName 'The Public Community'</dev:code> <dev:remarks> <maml:para>Returns the object representing "The Public Community".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloDiskImage</command:name> <maml:description> <maml:para>Get the Disk Image(s)</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloDiskImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get the Disk Image. By default all Disk Images will be returned. By using the SharedWithMe switch only the shared Disk Images will be returned</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloDiskImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedWithMe</maml:name> <maml:description> <maml:para>Only return Disk Images that are shared with the user's account</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloDiskImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedWithMe</maml:name> <maml:description> <maml:para>Only return Disk Images that are shared with the user's account</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloDiskImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedWithMe</maml:name> <maml:description> <maml:para>Only return Disk Images that are shared with the user's account</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedWithMe</maml:name> <maml:description> <maml:para>Only return Disk Images that are shared with the user's account</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloDiskImage</dev:code> <dev:remarks> <maml:para>Returns all Disk Images</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloDiskImage -SharedWithMe</dev:code> <dev:remarks> <maml:para>Return all Disk Images that are shared with the caller's account</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloDiskImage -DiskImageName win10.iso</dev:code> <dev:remarks> <maml:para>Return the Disk Image that is named 'win10.iso'</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloDiskImageDocumentation</command:name> <maml:description> <maml:para>Get the Documentation for a Disk Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloDiskImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Documentation for the Disk Image. The Documentation is in Markdown format</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloDiskImageDocumentation -DiskImageName win10.iso</dev:code> <dev:remarks> <maml:para>Returns the Markdown documentation connected to the Disk Image, named win10.iso</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloElasticIP</command:name> <maml:description> <maml:para>Get the Elastic IP(s)</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloElasticIP</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns a list of all the Elastic IP addresses in the Organization</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloElasticIP</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloElasticIP</dev:code> <dev:remarks> <maml:para>Returns all the Elastic IP addresses defined in the caller's Organization</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloElasticIPLocation</command:name> <maml:description> <maml:para>Get available locations for the Elastic IP addresses</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloElasticIPLocation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns a list of the all the available locations for Elastic IP address pools</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloElasticIPLocation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloElasticIPLocation</dev:code> <dev:remarks> <maml:para>Returns all the available locations for Elastic IP address pools</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloEphemeralAccessToken</command:name> <maml:description> <maml:para>Get one or more Ephemeral access tokens</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloEphemeralAccessToken</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Ephemeral Access token(s). These are used to give temporary access to resources without having a Ravello account.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloEphemeralAccessToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloEphemeralAccessToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloEphemeralAccessToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloEphemeralAccessToken</dev:code> <dev:remarks> <maml:para>Returns all the defined Ephemeral Access tokens</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloEphemeralAccessToken -EphemeralAccessTokenName Token1</dev:code> <dev:remarks> <maml:para>Returns the Ephemeral Access token, named Token1. Note that the Ephemeral Access token object contain sthe expiration date of the token.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloEphemeralTokenURL</command:name> <maml:description> <maml:para>Get the URL to access the resources that are accessible through an Ephemeral Access token</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloEphemeralTokenURL</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>The cmdlet returns the URL to access the resources for which the Ephemeral Access token defines access. One URL connects to the VM directly, like a console. The other URL provides access through a Ravello interface, where the user can also perform basic task (Start,Stop...) on the permitted VM resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloEphemeralTokenURL</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloEphemeralTokenURL</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloEphemeralTokenURL</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloEphemeralTokenURL -EphemeralAccessTokenName Token1</dev:code> <dev:remarks> <maml:para>Returns the URL for accessing the resource(s) that are defined in the Ephemeral Token. There are 2 URL returned: - the RavelloUI which opens a web interface siilar to the standard Ravello Web Gui, but limited to the resources for which the Ephemeral Token has permissions - a EndUserUI: only available when the Ephemertal Token gives access to only one Application. It's dedicated Web Gui to interact with the Application for which the Token has permissions</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloEvent</command:name> <maml:description> <maml:para>Get-RavelloEvent [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloEvent</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns a list of all the available events in the system</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloEvent</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloEvent</dev:code> <dev:remarks> <maml:para>Returns all available events in the system.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloImage</command:name> <maml:description> <maml:para>Get public and private Images</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Return one or more Images, eventually limited to private Images under the Organization</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>Only return the Images stored under the Organization</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>Only return the Images stored under the Organization</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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloImage</dev:code> <dev:remarks> <maml:para>Return all Images</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloImage -Private</dev:code> <dev:remarks> <maml:para>Return only the Images stored under the User's Organization</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloImage -ImageName Img1</dev:code> <dev:remarks> <maml:para>Return a specific Image. When called with ImageName or ImageId, the returned object for the Image contains more detailed information</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloImageDocumentation</command:name> <maml:description> <maml:para>Get the Documentation associated with the Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Documentation for the Image. The Documentation is in Markdown format</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloImageDocumentation -ImageName Img1</dev:code> <dev:remarks> <maml:para>Returns the Markdown documentation associated with the Image, named Img1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloImportHistory</command:name> <maml:description> <maml:para>Get the history of imports</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloImportHistory</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the import history made from the invoking station.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloImportHistory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CliPath</maml:name> <maml:description> <maml:para>Path to the Ravello CLI VM Import Tool for Windows</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CliPath</maml:name> <maml:description> <maml:para>Path to the Ravello CLI VM Import Tool for Windows</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloImportHistory</dev:code> <dev:remarks> <maml:para>Returns the history of imports made from the station where the cmdlet is called.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloKeyPair</command:name> <maml:description> <maml:para>Get the Key Pairs in the Organization Get-RavelloKeyPair -KeyPairId <long> [<CommonParameters>] Get-RavelloKeyPair -KeyPairName <string> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloKeyPair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns a list of all the Key Pairs in the authenticated user Organization. The key pairs returned consist of only the ID and name; the key (private or public) itself is not returned.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloKeyPair</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairId</maml:name> <maml:description> <maml:para>The ID of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairId</maml:name> <maml:description> <maml:para>The ID of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloKeyPair</dev:code> <dev:remarks> <maml:para>Returns all the Key Pairs in the User's Organization</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloKeyPair -KeyPairId 12345678</dev:code> <dev:remarks> <maml:para>Returns the Key Pair with the Id 12345678</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloNotification</command:name> <maml:description> <maml:para>Get Notifications</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloNotification</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Return Notifications with the specified criteria.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloNotification</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NotificationLevel</maml:name> <maml:description> <maml:para>The level of the Notifications to search. Possible values are ERROR, INFO, TRACE and WARN</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The amount of Notifications to return</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>A start date The default is 01/01/1970, when a Finish DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>A finish date. The default is the current DateTime, when a Start DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloNotification</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NotificationLevel</maml:name> <maml:description> <maml:para>The level of the Notifications to search. Possible values are ERROR, INFO, TRACE and WARN</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The amount of Notifications to return</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>A start date The default is 01/01/1970, when a Finish DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>A finish date. The default is the current DateTime, when a Start DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloNotification</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NotificationLevel</maml:name> <maml:description> <maml:para>The level of the Notifications to search. Possible values are ERROR, INFO, TRACE and WARN</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The amount of Notifications to return</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>A start date The default is 01/01/1970, when a Finish DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>A finish date. The default is the current DateTime, when a Start DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NotificationLevel</maml:name> <maml:description> <maml:para>The level of the Notifications to search. Possible values are ERROR, INFO, TRACE and WARN</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The amount of Notifications to return</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>A start date The default is 01/01/1970, when a Finish DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>A finish date. The default is the current DateTime, when a Start DateTime is given</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloNotification</dev:code> <dev:remarks> <maml:para>Returns all Notifications</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloNotification -NotificationLevel ERROR -MaxResults 10</dev:code> <dev:remarks> <maml:para>Get the last 10 ERROR Notifications. The Notifications are returned most recent to oldest</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloNotification -ApplicationName App1 -Start (Get-Date "01/12/2015")</dev:code> <dev:remarks> <maml:para>Get all Notifications for an Application, called App1, since 01/12/2015</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloOrganization</command:name> <maml:description> <maml:para>Get the Organization details Get-RavelloOrganization -OrganizationId <long> [-Users] [<CommonParameters>] Get-RavelloOrganization -OrganizationName <string> [-Users] [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloOrganization</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the Organization details or the list if Users defined in the Organization</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloOrganization</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloOrganization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The ID of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <maml:description> <maml:para>Return the Users defined in the Organization</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloOrganization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <maml:description> <maml:para>Return the Users defined in the Organization</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The ID of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <maml:description> <maml:para>Return the Users defined in the Organization</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloOrganization</dev:code> <dev:remarks> <maml:para>Returns the Organization of the authenticated User</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloOrganization -OrganizationId 12345678 -Users</dev:code> <dev:remarks> <maml:para>Return the Users defined in an Organization, with the Id 123456578</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloOrganization -OrganizationName Org1</dev:code> <dev:remarks> <maml:para>Return the Organization with the name Org1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloPermissionDescriptor</command:name> <maml:description> <maml:para>Get Permission Descriptors</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloPermissionDescriptor</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns a list of resource permission descriptors that describe the configuration possibilities of this resource permission, such as supported properties and actions.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloPermissionDescriptor</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>A valid Resource Type. These can be obtained by calling the cmdlet without any parameter. The resourceType property will show all valid Resource Types</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>A valid Resource Type. These can be obtained by calling the cmdlet without any parameter. The resourceType property will show all valid Resource Types</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloPermissionDescriptor</dev:code> <dev:remarks> <maml:para>Return all the valid Resource permission descriptors</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloPermissionDescriptor -ResourceType APPLICATION</dev:code> <dev:remarks> <maml:para>Return the Permission descriptor for the Application resource</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloPermissionsGroup</command:name> <maml:description> <maml:para>Get the Permission Group(s) Get-RavelloPermissionsGroup -Users [-PermissionGroupId <long>] [-PermissionGroupName <string>] [<CommonParameters>] Get-RavelloPermissionsGroup -PermissionGroupId <long> [<CommonParameters>] Get-RavelloPermissionsGroup -PermissionGroupName <string> [<CommonParameters>] Get-RavelloPermissionsGroup -UserId <long> [<CommonParameters>] Get-RavelloPermissionsGroup -UserName <string> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloPermissionsGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns one or more Permission Groups. A permission group is a set of permitted actions on a certain set of resources.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloPermissionsGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <maml:description> <maml:para>Return the Users in the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <maml:description> <maml:para>Return the Users in the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <maml:description> <maml:para>Return the Users in the Permission Group</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml: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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml: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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloPermissionsGroup</dev:code> <dev:remarks> <maml:para>Returns all the Permission Groups defined in the Organization of the authenticated User</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloPermissionsGroup -PermissionGroupName PG1</dev:code> <dev:remarks> <maml:para>Returns the Permission Group, named PG1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloPermissionsGroup -PermissionGroupId 12345678 -Users</dev:code> <dev:remarks> <maml:para>Returns all the Users that are member of the Permission Group, with Id 12345678</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloPermissionsGroup -FirstName John -LastName</dev:code> <dev:remarks> <maml:para>Returns all the Permission Groups in which User 'John Doe' is a member</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloRepoBlueprint</command:name> <maml:description> <maml:para>Get the Blueprint(s) available in a Repository</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloRepoBlueprint</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Return the Blueprints from a Repository</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloRepoBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloRepoBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloRepoBlueprint -CommunityId 12345678</dev:code> <dev:remarks> <maml:para>Returns all the Blueprints stored in the Community, with Id 12345678, repository</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloRepoBlueprint -CommunityName 'The Public Community' -BlueprintId 12345678</dev:code> <dev:remarks> <maml:para>Returns the Blueprint, with Id 12345678, stored in the Community, named 'The Public Community'</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloRepoDisk</command:name> <maml:description> <maml:para>Get the Disk(s) available in a Repository</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloRepoDisk</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Return the Disks from a Repository</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloRepoDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloRepoDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloRepoDisk -CommunityId 12345678</dev:code> <dev:remarks> <maml:para>Returns all the Disks stored in the Community, with Id 12345678, repository</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloRepoDisk -CommunityName 'The Public Community' -DiskId 12345678</dev:code> <dev:remarks> <maml:para>Returns the Disk, with Id 12345678, stored in the Community, named 'The Public Community'</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloRepoVm</command:name> <maml:description> <maml:para>Get the VM(s) available in a Repository</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloRepoVm</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Return the VMs from a Repository</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloRepoVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloRepoVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>CommunityId</maml:name> <maml:description> <maml:para>The ID of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The Name of the Community</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloRepoVm -CommunityName 12345678</dev:code> <dev:remarks> <maml:para>Returns all the VMs stored in the Community, with Id 12345678, repository</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloRepoVm -CommunityName 'The Public Community' -VmId 12345678</dev:code> <dev:remarks> <maml:para>Returns the VM, with Id 12345678, stored in the Community, named 'The Public Community'</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloShare</command:name> <maml:description> <maml:para>Get the Shares from the Organization</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloShare</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns a list of share records, optional filters could be used.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloShare</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareId</maml:name> <maml:description> <maml:para>The ID of the Share</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEmail</maml:name> <maml:description> <maml:para>Email address of the user with whom the resource is shared</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The resourcetype of the shared resource. Valid values are BLUEPRINT, LIBRARY_VM, DISK_IMAGE.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceName</maml:name> <maml:description> <maml:para>The Name of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceId</maml:name> <maml:description> <maml:para>The ID of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloShare</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareId</maml:name> <maml:description> <maml:para>The ID of the Share</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharingUserFirstName</maml:name> <maml:description> <maml:para>The Firstname of the User who shares the resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharingUserLastName</maml:name> <maml:description> <maml:para>The Lasstname of the User who shares the resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEmail</maml:name> <maml:description> <maml:para>Email address of the user with whom the resource is shared</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The resourcetype of the shared resource. Valid values are BLUEPRINT, LIBRARY_VM, DISK_IMAGE.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceName</maml:name> <maml:description> <maml:para>The Name of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceId</maml:name> <maml:description> <maml:para>The ID of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloShare</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareId</maml:name> <maml:description> <maml:para>The ID of the Share</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="id"> <maml:name>SharingUserId</maml:name> <maml:description> <maml:para>The Id of the User that shares the resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEmail</maml:name> <maml:description> <maml:para>Email address of the user with whom the resource is shared</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The resourcetype of the shared resource. Valid values are BLUEPRINT, LIBRARY_VM, DISK_IMAGE.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceName</maml:name> <maml:description> <maml:para>The Name of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceId</maml:name> <maml:description> <maml:para>The ID of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareId</maml:name> <maml:description> <maml:para>The ID of the Share</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEmail</maml:name> <maml:description> <maml:para>Email address of the user with whom the resource is shared</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The resourcetype of the shared resource. Valid values are BLUEPRINT, LIBRARY_VM, DISK_IMAGE.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceName</maml:name> <maml:description> <maml:para>The Name of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceId</maml:name> <maml:description> <maml:para>The ID of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharingUserFirstName</maml:name> <maml:description> <maml:para>The Firstname of the User who shares 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharingUserLastName</maml:name> <maml:description> <maml:para>The Lasstname of the User who shares 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="id"> <maml:name>SharingUserId</maml:name> <maml:description> <maml:para>The Id of the User that shares the resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloShare</dev:code> <dev:remarks> <maml:para>Returns all Shares in the Organization</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloShare -TargetEmail 'jane.doe@domain.com'</dev:code> <dev:remarks> <maml:para>Returns all the shares with the User with email address jane.doe@domain.com</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloShare -ResourceType BLUEPRINT</dev:code> <dev:remarks> <maml:para>Returns all shares of Blueprint resources</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloShare -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>Returns all shares created by a User, named John Doe</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloTask</command:name> <maml:description> <maml:para>Get Application Task(s)</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloTask</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns all Application Tasks.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloTask -ApplicationId 12345678</dev:code> <dev:remarks> <maml:para>Returns all the Tasks associated with an Application, with the Id 21345678</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloTask -ApplicationName App1 -TaskId 12345678</dev:code> <dev:remarks> <maml:para>Returns the Task, with Id 12345678, associated with an Application, named App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloUsage</command:name> <maml:description> <maml:para>Returns the usage data for the connected user</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloUsage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para/> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloUsage</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUsage</dev:code> <dev:remarks> <maml:para>Returns Usage info</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloUser</command:name> <maml:description> <maml:para>Get (a) User(s) Get-RavelloUser -UserName <string> [<CommonParameters>] Get-RavelloUser -UserId <long> [<CommonParameters>] Get-RavelloUser -All [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloUser</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns the User(s).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Return all Users in the Organization</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Return all Users in the Organization</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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUser</dev:code> <dev:remarks> <maml:para>Get the authenticated User</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUser -All</dev:code> <dev:remarks> <maml:para>Get all Users in the Organization</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUser -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>Get the User, named John Doe</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-RavelloUserAlert</command:name> <maml:description> <maml:para>Get User Alerts</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RavelloUserAlert</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Returns a list of all the alerts that a specific user is registered to. If the user is an administrator this call returns a list of all the alerts that the organization was registered too.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-RavelloUserAlert</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUserAlert</dev:code> <dev:remarks> <maml:para>Get the User Alerts</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Grant-RavelloShare</command:name> <maml:description> <maml:para>Share a resource with a User</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Grant</command:verb> <command:noun>RavelloShare</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Shares a specific resource with a target user.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Grant-RavelloShare</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceName</maml:name> <maml:description> <maml:para>The Name of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEmail</maml:name> <maml:description> <maml:para>Email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The resourcetype of the shared resource. Valid values are BLUEPRINT, LIBRARY_VM, DISK_IMAGE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Grant-RavelloShare</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceId</maml:name> <maml:description> <maml:para>The ID of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEmail</maml:name> <maml:description> <maml:para>Email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The resourcetype of the shared resource. Valid values are BLUEPRINT, LIBRARY_VM, DISK_IMAGE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceName</maml:name> <maml:description> <maml:para>The Name of the Shared 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEmail</maml:name> <maml:description> <maml:para>Email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The resourcetype of the shared resource. Valid values are BLUEPRINT, LIBRARY_VM, DISK_IMAGE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedResourceId</maml:name> <maml:description> <maml:para>The ID of the Shared Resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <maml:alertSet> <!--Notes--> <maml:title>Sharing restrictions</maml:title> <maml:alert> <maml:para>Sharing resources within the same Organization is currently not supported</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Grant-RavelloShare -SharedResourceName BP1 -ResourceType BLUEPRINT -TargetEmail 'john.doe@domain.com'</dev:code> <dev:remarks> <maml:para>Shares the Blueprint, named BP1, with the User whose email address is john.doe@domain.com</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Import-Ravello</command:name> <maml:description> <maml:para>Import resources into the Organization</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Import</command:verb> <command:noun>Ravello</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Uses the Ravello Import CLI to import resources into the Organization. The imported resources can be an ISO file on local storage, a vDisk stored on local storage or a VM from a vSPhere environment. This cmdlet assumes that the Ravello Import CLI is locally installed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Import-Ravello</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CliPath</maml:name> <maml:description> <maml:para>Path to the Ravello CLI VM Import Tool for Windows</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsoPath</maml:name> <maml:description> <maml:para>Path to the ISO file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-Ravello</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CliPath</maml:name> <maml:description> <maml:para>Path to the Ravello CLI VM Import Tool for Windows</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmPath</maml:name> <maml:description> <maml:para>Path to the VM's VMX file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-Ravello</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CliPath</maml:name> <maml:description> <maml:para>Path to the Ravello CLI VM Import Tool for Windows</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EsxVmPath</maml:name> <maml:description> <maml:para>Path to the VM's VMX file (format '[datastore] folder\vm.vmx')</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EsxServer</maml:name> <maml:description> <maml:para>FQDN of the ESXi node that hosts the VM to be imported</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EsxCredential</maml:name> <maml:description> <maml:para>Credentials to connect to the ESXi node</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-Ravello</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CliPath</maml:name> <maml:description> <maml:para>Path to the Ravello CLI VM Import Tool for Windows</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskPath</maml:name> <maml:description> <maml:para>Path to the Disk file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CliPath</maml:name> <maml:description> <maml:para>Path to the Ravello CLI VM Import Tool for Windows</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>C:\ravello_cli</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsoPath</maml:name> <maml:description> <maml:para>Path to the ISO 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmPath</maml:name> <maml:description> <maml:para>Path to the VM's VMX 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EsxVmPath</maml:name> <maml:description> <maml:para>Path to the VM's VMX file (format '[datastore] folder\vm.vmx')</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EsxServer</maml:name> <maml:description> <maml:para>FQDN of the ESXi node that hosts the VM to be imported</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EsxCredential</maml:name> <maml:description> <maml:para>Credentials to connect to the ESXi node</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskPath</maml:name> <maml:description> <maml:para>Path to the Disk 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/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-Ravello -IsoPath file.iso</dev:code> <dev:remarks> <maml:para>Imports the ISO file into the Organization's library under Disk Images</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-Ravello -EsxVmPath $VmPathName -EsxCredential $credEsx -EsxServer $EsxServer</dev:code> <dev:remarks> <maml:para>Import a VM from an ESXi node into the Organization's VM library</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-Ravello -DiskPath D:\VM1\vm1.vmdk</dev:code> <dev:remarks> <maml:para>Imports a Virtual Disk, a VMDK file, into the Organization's Disk Images library</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-Ravello -VmPath C:\vm2.vmx</dev:code> <dev:remarks> <maml:para>Imports a VM from local storage into the Organization's VM library</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Invoke-RavelloApplicationAction</command:name> <maml:description> <maml:para>Perform an action on an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>RavelloApplicationAction</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Perform an action on a published Application. The allowed actions are PublishUpdates, Start, Stop, Restart and ResetDisks.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-RavelloApplicationAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to be performed on the Application. Following actions are accepted: PublishUpdates: updates the cloud according to the current Application data (design) Start: start all the application VMs Stop: stop all the application VMs Restart: restart all the application VMs ResetDisks: reset each of the VM disks to its most recent applicable state</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartAllVms</maml:name> <maml:description> <maml:para>Only valid in combination with the PublishUpdates action. When set, newly added VMs will start after the PublishUpdates action.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-RavelloApplicationAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to be performed on the Application. Following actions are accepted: PublishUpdates: updates the cloud according to the current Application data (design) Start: start all the application VMs Stop: stop all the application VMs Restart: restart all the application VMs ResetDisks: reset each of the VM disks to its most recent applicable state</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartAllVms</maml:name> <maml:description> <maml:para>Only valid in combination with the PublishUpdates action. When set, newly added VMs will start after the PublishUpdates action.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to be performed on the Application. Following actions are accepted: PublishUpdates: updates the cloud according to the current Application data (design) Start: start all the application VMs Stop: stop all the application VMs Restart: restart all the application VMs ResetDisks: reset each of the VM disks to its most recent applicable state</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartAllVms</maml:name> <maml:description> <maml:para>Only valid in combination with the PublishUpdates action. When set, newly added VMs will start after the PublishUpdates action.</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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-RavelloApplicationAction -ApplicationName App1 -Action PublishUpdates -StartAllVms</dev:code> <dev:remarks> <maml:para>Updates the Cloud according to the current Design data.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-RavelloApplicationAction -ApplicationId 12345678 -Action Start</dev:code> <dev:remarks> <maml:para>Start all the VMs, that are not already started, in the APplication, with Id 12345678</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Invoke-RavelloApplicationVMAction</command:name> <maml:description> <maml:para>Perform an action on or more VMs in an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>RavelloApplicationVMAction</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Perform an action on or more VMs in a publsihed Application. The cmdlet doesn't wait for the actual completion of the Action. It comes back the moment the Action has been passed to the VMs in the Application.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-RavelloApplicationVMAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to take on the VM(s) The accepted actions are stop: stop the VM(s) start: start the VM(s) shutdown: shutdown the VM(s). Gracefull poweroff: poweroff the VM(s). This is non-gracefull restart: restart the VM(s) redeploy: shut down the VM(s) and replace it/them with a new copy repair: makes an attempt to repair the VM(s) without destroying the data resetDisk:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-RavelloApplicationVMAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to take on the VM(s) The accepted actions are stop: stop the VM(s) start: start the VM(s) shutdown: shutdown the VM(s). Gracefull poweroff: poweroff the VM(s). This is non-gracefull restart: restart the VM(s) redeploy: shut down the VM(s) and replace it/them with a new copy repair: makes an attempt to repair the VM(s) without destroying the data resetDisk:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-RavelloApplicationVMAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to take on the VM(s) The accepted actions are stop: stop the VM(s) start: start the VM(s) shutdown: shutdown the VM(s). Gracefull poweroff: poweroff the VM(s). This is non-gracefull restart: restart the VM(s) redeploy: shut down the VM(s) and replace it/them with a new copy repair: makes an attempt to repair the VM(s) without destroying the data resetDisk:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-RavelloApplicationVMAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to take on the VM(s) The accepted actions are stop: stop the VM(s) start: start the VM(s) shutdown: shutdown the VM(s). Gracefull poweroff: poweroff the VM(s). This is non-gracefull restart: restart the VM(s) redeploy: shut down the VM(s) and replace it/them with a new copy repair: makes an attempt to repair the VM(s) without destroying the data resetDisk:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The Action to take on the VM(s) The accepted actions are stop: stop the VM(s) start: start the VM(s) shutdown: shutdown the VM(s). Gracefull poweroff: poweroff the VM(s). This is non-gracefull restart: restart the VM(s) redeploy: shut down the VM(s) and replace it/them with a new copy repair: makes an attempt to repair the VM(s) without destroying the data resetDisk:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-RavelloApplicationVMAction -ApplicationName App1 -VmName VM1,VM2 -Action start</dev:code> <dev:remarks> <maml:para>This will start the VMs, called VM1 and VM2, in the Application, called App1. The cmdlet will return the moment the action is communicated to the VMs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-RavelloApplicationVMAction -ApplicationId 12345678 -VmId 87654321 -Action poweroff</dev:code> <dev:remarks> <maml:para>This line will immediatly, and ungracefull, stop the VM, with Id 87654321, in the Application, with Id 12345678.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloApplication</command:name> <maml:description> <maml:para>Create an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloApplication</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a new Application.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmImageId</maml:name> <maml:description> <maml:para>The ID of the VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmImageName</maml:name> <maml:description> <maml:para>The Name of the VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmImageId</maml:name> <maml:description> <maml:para>The ID of the VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmImageName</maml:name> <maml:description> <maml:para>The Name of the VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloApplication -ApplicationName App1 -Description 'Sample Application'</dev:code> <dev:remarks> <maml:para>Creates an Application, with the name App1, and a Description of 'Sample Application'. The Application is an empty Application. It's not based on a Blueprint, nor are there any VM added during the creation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloApplication -ApplicationName App1 -BlueprintName BP1</dev:code> <dev:remarks> <maml:para>Creates a new Application, named App1, that is based on the Blueprint called BP1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloApplication -ApplicationName App1 -VmImageName 'VM1','VM2'</dev:code> <dev:remarks> <maml:para>Create a new Application, named App1, which will contain 2 VMs, named VM1 and VM2. The VMs will be retrieved from the VM library</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloApplicationDocumentation</command:name> <maml:description> <maml:para>Create Application documentation</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloApplicationDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create the Application documentation. The documentation is provided in the Github Flavored Markdown format.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Application. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Application. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Application. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloApplicationDocumentation -ApplicationName App1 -Documentation $text</dev:code> <dev:remarks> <maml:para>The content of the variable $text is assigned to the Documentation of the Application, named App1</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Github Flavored Markdown</maml:linkText> <maml:uri>https://help.github.com/articles/github-flavored-markdown</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloApplicationOrderGroup</command:name> <maml:description> <maml:para>Create Startup and Shutdown Order groups</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloApplicationOrderGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create Startup and Shutdown Order groups for an Application. The actual composition and order of the groups is defined in an array of objects. Each object defines one group. Such an object needs to have the following properties Name = the name of the group DelaySeconds = the number of seconds before the next group is started VM = an array with names of the VM in this group</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloApplicationOrderGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartOrder</maml:name> <maml:description> <maml:para>An array of objects, that define the groups. Each object defines one group. Such an object needs to have the following properties Name = the name of the group DelaySeconds = the number of seconds before the next group is started VM = an array with names of the VM in this group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloApplicationOrderGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartOrder</maml:name> <maml:description> <maml:para>An array of objects, that define the groups. Each object defines one group. Such an object needs to have the following properties Name = the name of the group DelaySeconds = the number of seconds before the next group is started VM = an array with names of the VM in this group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartOrder</maml:name> <maml:description> <maml:para>An array of objects, that define the groups. Each object defines one group. Such an object needs to have the following properties Name = the name of the group DelaySeconds = the number of seconds before the next group is started VM = an array with names of the VM in this group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$order = $order = @{ Name = 'Group1' DelaySeconds = 300 VM = 'VM1','VM2' },@{ Name = 'Group2' DelaySeconds = 0 VM = 'VM3' } New-RavelloApplicationOrderGroup -ApplicationName App1 -StartOrder $order</dev:code> <dev:remarks> <maml:para>This will create two Startup and Shutdown groups in the Application, called App1. The groups are named Group1 and Group2. Group2 is started 300 seconds after Groups is started. In Group1 are VMs named VM1 and VM2 In Group2 is the VM named VM3</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloBlueprint</command:name> <maml:description> <maml:para>Create a new Blueprint</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloBlueprint</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a new Blueprint based on an Application.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the new Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the new Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the new Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloBlueprint -BlueprintName BP1 -ApplicationName App1 -Description 'A new Blueprint'</dev:code> <dev:remarks> <maml:para>This will create a new Blueprint, named BP1, that is created from the Application, named App1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloBlueprintDocumentation</command:name> <maml:description> <maml:para>Create Blueprint documentation</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloBlueprintDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create the Blueprint documentation. The documentation is provided in the Github Flavored Markdown format.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Blueprint. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Blueprint. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Blueprint. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloBlueprintDocumentation -BlueprintName BP1 -Documentation $text</dev:code> <dev:remarks> <maml:para>The content of the variable $text is assigned to the Documentation of the Blueprint, named BP1</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Github Flavored Markdown</maml:linkText> <maml:uri>https://help.github.com/articles/github-flavored-markdown</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloDiskImage</command:name> <maml:description> <maml:para>Creates a new Disk Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloDiskImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a new Disk Image from an existing Blueprint VM, Application VM or library VM</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDiskName</maml:name> <maml:description> <maml:para>The new Name of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs should be powered off before taking the action</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskId</maml:name> <maml:description> <maml:para>The ID of the Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloDiskImage -ApplicationName App1 -VmName VM1 -DiskName hda -NewDiskName disk1 -Description 'Test'</dev:code> <dev:remarks> <maml:para>Creates a new Disk Image from the disk, named hda, in the VM, named VM1, in the Application, named App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloDiskImage -ApplicationName App1 -VmName VM1 -DiskId 12345678 -NewDiskName disk2 -Description 'Test'</dev:code> <dev:remarks> <maml:para>Similar to Example 1, but for the Disk, the DiskId is used.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App1 | New-RavelloDiskImage -VmId 12345678 -DiskId 45678 -NewDiskName disk3 -Description 'Test' -Confirm:$false</dev:code> <dev:remarks> <maml:para>The Application is passed through the pipeline. The new disk, called disk3, is created from the dish with Id 45678 in the VM with Id 12345678. Note1 that the Confirm message is suppressed Note2 only Application is accepted through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloDiskImage -BlueprintName BP1 -VmName VM1 -DiskName hda -NewDiskName Disk4 -Description 'Test'</dev:code> <dev:remarks> <maml:para>A new Disk Image is created from the disk, called hda, in the VM, called VM1, in the Blueprint, called BP1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloDiskImageDocumentation</command:name> <maml:description> <maml:para>Create Disk Image documentation</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloDiskImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create the Disk Image documentation. The documentation is provided in the Github Flavored Markdown format.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Disk Image. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Disk Image. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation that will be attached to the Disk Image. Documentation is Github Flavored Markdown</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloDiskImageDocumentation -DiskImageName Disk1 -Documentation $doc</dev:code> <dev:remarks> <maml:para>The content of the variable $doc is assigned to the Documentation of the Disk Image, named Disk1</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Github Flavored Markdown</maml:linkText> <maml:uri>https://help.github.com/articles/github-flavored-markdown</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloElasticIP</command:name> <maml:description> <maml:para>Create a new Elastic IP</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloElasticIP</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a new Elastic IP</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloElasticIP</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the IP address pool where the elastic IP address will be created. Use the Get-RavelloElasticIPLocation cmdlet to find the available locations</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the Elastic IP. If no Name value is passed, the Elastic IP entry is created without a Name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>If no Description value is passed, the Elastic IP entry is created without a Description</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the IP address pool where the elastic IP address will be created. Use the Get-RavelloElasticIPLocation cmdlet to find the available locations</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>The Ravello engine selects a location for you</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the Elastic IP. If no Name value is passed, the Elastic IP entry is created without a Name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>If no Description value is passed, the Elastic IP entry is created without a Description</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloElasticIP -Location 'Sydney' -Name EIP1 -Description 'Elastic IP'</dev:code> <dev:remarks> <maml:para>Creates an Elastic IP for the location Sydney, with a name of EIP1 and a description</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloElasticIP</dev:code> <dev:remarks> <maml:para>Creates an Elastic IP. The system picks a Location for you.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloElasticIP -Name EIP1</dev:code> <dev:remarks> <maml:para>Creates an Elastic IP. The system will pick the Location. There will be no Description</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloEphemeralAccessToken</command:name> <maml:description> <maml:para>Create an Ephemeral Access Token</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloEphemeralAccessToken</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates an Ephemeral Access Token. The token can have a permissions with specific filters. That way you can limit to what a specific Ephemeral Access Token has access.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloEphemeralAccessToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExpirationTime</maml:name> <maml:description> <maml:para>DateTime when the object will expire</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>The Permissions assigned to the Ephemeral Access Token. These Permissions can be created with the New-RavelloPermission cmdlet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExpirationTime</maml:name> <maml:description> <maml:para>DateTime when the object will expire</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>Three days from Now</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>The Permissions assigned to the Ephemeral Access Token. These Permissions can be created with the New-RavelloPermission cmdlet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloEphemeralAccessToken -EphemeralAccessTokenName EAT1 -ExpirationTime (Get-Date).AddDays(2)</dev:code> <dev:remarks> <maml:para>Creates an Ephemeral Access Token, with an Expiration Date two days from now</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$app = Get-RavelloApplication -ApplicationName MyApp $filter = New-RavelloPermissionFilter -Property ID -Operator Equals -Operand $app.id $perm = New-RavelloPermission -ResourceType APPLICATION -Action READ,EXECUTE -FilterOperand Or -Filter $filter New-RavelloEphemeralAccessToken -EphemeralAccessTokenName EAT2 -Permissions $perm</dev:code> <dev:remarks> <maml:para>This example creates an Ephemeral Access Token, valid for three days, that will give 'execute' access to the Application, with the Name MyApp.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloImage</command:name> <maml:description> <maml:para>Create a new Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a new Image from an existing Blueprint VM or an Application VM.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>AppBpId</maml:name> <maml:description> <maml:para>The Id of the source Application or Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewImageName</maml:name> <maml:description> <maml:para>The new Name of the Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs, if you are using an Application as the source, should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewImageName</maml:name> <maml:description> <maml:para>The new Name of the Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs, if you are using an Application as the source, should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewImageName</maml:name> <maml:description> <maml:para>The new Name of the Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs, if you are using an Application as the source, should be powered off before taking the action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>AppBpId</maml:name> <maml:description> <maml:para>The Id of the source Application or Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the source VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewImageName</maml:name> <maml:description> <maml:para>The new Name of the Image</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to idicate that the VMs, if you are using an Application as the source, should be powered off before taking the action</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloImage -ApplicationName App1 -VmName VM1 -NewImageName VM2 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Creates a new Image (VM) from the VM, called VM1, in the Application, called App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloImage -BlueprintName BP1 -VmName VM1 -NewImageName VM2</dev:code> <dev:remarks> <maml:para>Creates a new Image (VM) from the VM, called VM1, in the Blueprint, called BP1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloBlueprint -BlueprintName BP1 | New-RavelloImage -VmName VM1 -NewImageName VM2</dev:code> <dev:remarks> <maml:para>Creates a new Image (VM) from the VM, called VM1, in the Blueprint, called BP1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloImageDocumentation</command:name> <maml:description> <maml:para/> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para/> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloImageDocumentation -ImageName VM1 -Documentation $doc</dev:code> <dev:remarks> <maml:para>The content of the variable $doc is assigned to the Documentation of the Image, named VM1</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Github Flavored Markdown</maml:linkText> <maml:uri>https://help.github.com/articles/github-flavored-markdown</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloKeyPair</command:name> <maml:description> <maml:para>Create a new Key Pair</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloKeyPair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a new Key Pair.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the new KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PublicKey</maml:name> <maml:description> <maml:para>The public key of the new key pair. The public key must be specified in OpenSSH format</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Generate</maml:name> <maml:description> <maml:para>Switch to create a new random Key Pair. This is a utility method, used to create a pair of private and public keys</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the new KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PublicKey</maml:name> <maml:description> <maml:para>The public key of the new key pair. The public key must be specified in OpenSSH 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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Generate</maml:name> <maml:description> <maml:para>Switch to create a new random Key Pair. This is a utility method, used to create a pair of private and public keys</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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$key = New-RavelloKeyPair -Generate New-RavelloKeyPair -PublicKey $key.publicKey -KeyPairName Key1</dev:code> <dev:remarks> <maml:para>This will first generate a new Key Pair and the keys are stored in the $key variable. With the Public Key a new Key Pair is created.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloPermission</command:name> <maml:description> <maml:para>Create a new Permission</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloPermission</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a new Permission. These new Permissions are used in Permission Groups</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloPermission</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The type of resource for which the Permission is created. The available types can be obtained through the Get-RavelloPermissionDescriptor cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Action</maml:name> <maml:description> <maml:para>The actions for which this permissions will be defined. The available actions depend on the type of resource. With the Get-RavelloPermissionDescriptor the available actions can be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FilterOperand</maml:name> <maml:description> <maml:para>The way filters (see the Filter parameter) will be combined. Possible values are "And' and 'Or'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Filter</maml:name> <maml:description> <maml:para>A Permission filter. These filters can be created with the New-RavelloPermissionFilter cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The type of resource for which the Permission is created. The available types can be obtained through the Get-RavelloPermissionDescriptor cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Action</maml:name> <maml:description> <maml:para>The actions for which this permissions will be defined. The available actions depend on the type of resource. With the Get-RavelloPermissionDescriptor the available actions can be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FilterOperand</maml:name> <maml:description> <maml:para>The way filters (see the Filter parameter) will be combined. Possible values are "And' and 'Or'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>Or</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Filter</maml:name> <maml:description> <maml:para>A Permission filter. These filters can be created with the New-RavelloPermissionFilter cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$app = Get-RavelloApplication -ApplicationName App1 $filter = New-RavelloPermissionFilter -Property ID -Operator Equals -Operand $app.id $perm = New-RavelloPermission -ResourceType APPLICATION -Action READ,EXECUTE -FilterOperand Or -Filter $filter</dev:code> <dev:remarks> <maml:para>A new Permission is created. The Permission allows the Actions READ and EXECUTE on an Application. The Permission uses a Filter where the Id of Application is validated. The Id is obtained by running the Get-RavelloApplication cmdlet against the App1 Application</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloPermissionFilter</command:name> <maml:description> <maml:para>Creates a new Permission Filter</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloPermissionFilter</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a new Permission Filter. These Filters will be used in Permissions.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloPermissionFilter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The name of the property that is used in the filter. The available properties for a resource type can be obtained with the Get-RavelloPermissionDescriptor cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The Operator field provides the operation that is used on the field that is defined in the Property parameter. The available operators for a specific resource can be obtained with the Get-RavelloPermissionDescriptor cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Operand</maml:name> <maml:description> <maml:para>The content of this field depends on the Property and the Operand parameters. If for example, the Property is the Id field, then this will contain the long value against which the check will happen. Note that some resources do not foresee a Filter option.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The name of the property that is used in the filter. The available properties for a resource type can be obtained with the Get-RavelloPermissionDescriptor cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The Operator field provides the operation that is used on the field that is defined in the Property parameter. The available operators for a specific resource can be obtained with the Get-RavelloPermissionDescriptor cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Operand</maml:name> <maml:description> <maml:para>The content of this field depends on the Property and the Operand parameters. If for example, the Property is the Id field, then this will contain the long value against which the check will happen. Note that some resources do not foresee a Filter option.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$app = Get-RavelloApplication -ApplicationName App1 $filter = New-RavelloPermissionFilter -Property ID -Operator Equals -Operand $app.id $perm = New-RavelloPermission -ResourceType APPLICATION -Action READ,EXECUTE -FilterOperand Or -Filter $filter</dev:code> <dev:remarks> <maml:para>A new Permission is created. The Permission allows the Actions READ and EXECUTE on an Application. The Permission uses a Filter where the Id of Application is validated. The Id is obtained by running the Get-RavelloApplication cmdlet against the App1 Application</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloPermissionsGroup</command:name> <maml:description> <maml:para>Create a new Permissions Group</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloPermissionsGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a new Permissions Group. Such a Permissions Group is a collection of one or more Permissions that are created by the New-RavelloPermission cmdlet</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PermissionsGroupName</maml:name> <maml:description> <maml:para>The name of the new Permissions Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>The Permissions that are created by the New-RavelloPermission cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PermissionsGroupName</maml:name> <maml:description> <maml:para>The name of the new Permissions 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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>The Permissions that are created by the New-RavelloPermission cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$app = Get-RavelloApplication -ApplicationName App1 $filter = New-RavelloPermissionFilter -Property ID -Operator Equals -Operand $app.id $perm = New-RavelloPermission -ResourceType APPLICATION -Action READ,EXECUTE -FilterOperand Or -Filter $filter New-RavelloPermissionsGroup -PermissionsGroupName PG1 -Description Test -Permissions $perm</dev:code> <dev:remarks> <maml:para>This uses the same example from the New-RavelloPermission cmdlet. But now a new Permissions Group, called PG1, is created from the Permission.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloTask</command:name> <maml:description> <maml:para>Schedule a new Application Task</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloTask</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Schedule a new Application Task. There are three types of Tasks available; Start an Application, Stop an Application and Save as Blueprint.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Save as Blueprint Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>The Start date of the Task if scheduled. If no Start is provided, the Task is started 10 minutes from now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>The Stop time of the Task If not provided, the Task will never end</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cron</maml:name> <maml:description> <maml:para>Cron expression scheduling using Quartz Job Scheduler syntax (see Link). Note that not all features of the Quartz Job Scheduler syntax are implemented.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to indicate of the Application shall be placed Offline before running the Save as Blueprint Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintPrefix</maml:name> <maml:description> <maml:para>The prefix that will be used to create the Blueprint name. Only when a Save as Blueprint Task is created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintDescription</maml:name> <maml:description> <maml:para>The description that will be added to the created Blueprint. Only when a Save as Blueprint Task is created</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StopTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Stop Application Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>The Start date of the Task if scheduled. If no Start is provided, the Task is started 10 minutes from now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>The Stop time of the Task If not provided, the Task will never end</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cron</maml:name> <maml:description> <maml:para>Cron expression scheduling using Quartz Job Scheduler syntax (see Link). Note that not all features of the Quartz Job Scheduler syntax are implemented.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Start Application Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>The Start date of the Task if scheduled. If no Start is provided, the Task is started 10 minutes from now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>The Stop time of the Task If not provided, the Task will never end</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cron</maml:name> <maml:description> <maml:para>Cron expression scheduling using Quartz Job Scheduler syntax (see Link). Note that not all features of the Quartz Job Scheduler syntax are implemented.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Save as Blueprint Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>The Start date of the Task if scheduled. If no Start is provided, the Task is started 10 minutes from now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>The Stop time of the Task If not provided, the Task will never end</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cron</maml:name> <maml:description> <maml:para>Cron expression scheduling using Quartz Job Scheduler syntax (see Link). Note that not all features of the Quartz Job Scheduler syntax are implemented.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to indicate of the Application shall be placed Offline before running the Save as Blueprint Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintPrefix</maml:name> <maml:description> <maml:para>The prefix that will be used to create the Blueprint name. Only when a Save as Blueprint Task is created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintDescription</maml:name> <maml:description> <maml:para>The description that will be added to the created Blueprint. Only when a Save as Blueprint Task is created</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StopTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Stop Application Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>The Start date of the Task if scheduled. If no Start is provided, the Task is started 10 minutes from now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>The Stop time of the Task If not provided, the Task will never end</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cron</maml:name> <maml:description> <maml:para>Cron expression scheduling using Quartz Job Scheduler syntax (see Link). Note that not all features of the Quartz Job Scheduler syntax are implemented.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Start Application Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>The Start date of the Task if scheduled. If no Start is provided, the Task is started 10 minutes from now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>The Stop time of the Task If not provided, the Task will never end</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cron</maml:name> <maml:description> <maml:para>Cron expression scheduling using Quartz Job Scheduler syntax (see Link). Note that not all features of the Quartz Job Scheduler syntax are implemented.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Save as Blueprint Task</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>The Start date of the Task if scheduled. If no Start is provided, the Task is started 10 minutes from now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finish</maml:name> <maml:description> <maml:para>The Stop time of the Task If not provided, the Task will never end</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cron</maml:name> <maml:description> <maml:para>Cron expression scheduling using Quartz Job Scheduler syntax (see Link). Note that not all features of the Quartz Job Scheduler syntax are implemented.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Switch to indicate of the Application shall be placed Offline before running the Save as Blueprint Task</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintPrefix</maml:name> <maml:description> <maml:para>The prefix that will be used to create the Blueprint name. Only when a Save as Blueprint Task is created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintDescription</maml:name> <maml:description> <maml:para>The description that will be added to the created Blueprint. Only when a Save as Blueprint Task is created</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StopTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Stop Application Task</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTask</maml:name> <maml:description> <maml:para>Switch to indicate you want to create a Start Application Task</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$start = (Get-Date).AddHours(2) $cron = "0 0 8 ? * 2-6 *" New-RavelloTask -ApplicationName App1 -StartTask -Description 'Start App' -Start $start -Cron $cron</dev:code> <dev:remarks> <maml:para>This will create a Task that will start the Application, named App1, every working day (Monday through Friday) at 08:00 UTC. The task will active 2 hours from now, and will run forever. Note that in the Web GUI the times are displayed as local time.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$cron = "0 0 17 ? * 2 *" New-RavelloTask -ApplicationName App1 -BlueprintTask -Description 'Create Blueprint' -Cron $cron ` -Offline:$false -BlueprintPrefix 'BP-Copy' -BlueprintDescription 'Auto BP Copy' -Finish $start.AddDays(7)</dev:code> <dev:remarks> <maml:para>This example will create a Task that will do a Save as Blueprint for Application named App1, every Monday at 17:00 UTC. The Task will be active 10 minutes from now, and will never end. Note that in the Web GUI the times are displayed as local time.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Quartz Job Scheduler syntax.</maml:linkText> <maml:uri>http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloUser</command:name> <maml:description> <maml:para>Invite a new Ravello User</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloUser</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Invite a new Ravello User into the Organization. The user will receive an Invite via email.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The ID of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Email address of the user. The invite will be send to this email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Email address of the user. The invite will be send to this email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The ID of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Email address of the user. The invite will be send to this email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloUser -OrganizationName MyOrg -FirstName John -LastName Doe -EmailAddress john.doe@domain.com</dev:code> <dev:remarks> <maml:para>Sends an Invite to the user John Doe on his email address john.doe@domain.com</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-RavelloUserAlert</command:name> <maml:description> <maml:para>Register a User to an Alert</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>RavelloUserAlert</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Register a User to an Alert. The available Alerts can be listed by the Get-RavelloEvent cmdlet</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-RavelloUserAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventName</maml:name> <maml:description> <maml:para>The name of the Event that will Alert the User Use Get-RavelloEvent to obtain a list of available Events</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The id of the User that will receive the Alert</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RavelloUserAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventName</maml:name> <maml:description> <maml:para>The name of the Event that will Alert the User Use Get-RavelloEvent to obtain a list of available Events</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The firstname of the User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The lastname of the User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventName</maml:name> <maml:description> <maml:para>The name of the Event that will Alert the User Use Get-RavelloEvent to obtain a list of available Events</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The id of the User that will receive the Alert</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The firstname of the User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The lastname of the User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-RavelloUserAlert -EventName VM_STARTED -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>An Alert will be sent to the User, named John Doe, each time the event VM_STARTED occurs.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Publish-RavelloApplication</command:name> <maml:description> <maml:para>Publish an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>RavelloApplication</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Publish an Application. The designed Application is pushed to deployment in the cloud.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Publish-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreferredCloud</maml:name> <maml:description> <maml:para>The preferred Cloud where to publish the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreferredRegion</maml:name> <maml:description> <maml:para>The Region in the preferred Cloud where to publish the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OptimizationLevel</maml:name> <maml:description> <maml:para>There are two possible values 'COST_OPTIMIZED' or 'PERFORMANCE_OPTIMIZED'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartAllVM</maml:name> <maml:description> <maml:para>A switch to indicate if the VMs in the published Application shall be started</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreferredCloud</maml:name> <maml:description> <maml:para>The preferred Cloud where to publish the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreferredRegion</maml:name> <maml:description> <maml:para>The Region in the preferred Cloud where to publish the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OptimizationLevel</maml:name> <maml:description> <maml:para>There are two possible values 'COST_OPTIMIZED' or 'PERFORMANCE_OPTIMIZED'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartAllVM</maml:name> <maml:description> <maml:para>A switch to indicate if the VMs in the published Application shall be started</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreferredCloud</maml:name> <maml:description> <maml:para>The preferred Cloud where to publish the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreferredRegion</maml:name> <maml:description> <maml:para>The Region in the preferred Cloud where to publish the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OptimizationLevel</maml:name> <maml:description> <maml:para>There are two possible values 'COST_OPTIMIZED' or 'PERFORMANCE_OPTIMIZED'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartAllVM</maml:name> <maml:description> <maml:para>A switch to indicate if the VMs in the published Application shall be started</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$app = Get-RavelloApplication -ApplicationName App1 if(!(Test-RavelloApplicationPublished -ApplicationId $app.id)) { $app | Publish-RavelloApplication -PreferredCloud GOOGLE -PreferredRegion europe-west1 ` -OptimizationLevel COST_OPTIMIZED -StartAllVM:$false }</dev:code> <dev:remarks> <maml:para>The example will Publish the Application named App1, when the Test-RavelloApplicationPublished call returns $False. This means that some changes where made to the design of the application, but that these changes have not been published, or deployed, yet. The call to Publish-RavelloAppliaction selects the Cloud, the preferred region in the cloud and the optimization level. The available Clouds and the regions can be retrieved through the Get-RavelloApplicationPublishLocation cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloApplication</command:name> <maml:description> <maml:para>Remove an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloApplication</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Removes an Application</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloApplication -ApplicationName App1</dev:code> <dev:remarks> <maml:para>Removes the Application named App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App1 | Remove-RavelloApplication -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the Application named App1. The Confirm switch avoids being prompted to confirm the deletion.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloApplicationDocumentation</command:name> <maml:description> <maml:para>Removes the Documentation from an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloApplicationDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Removes the Documentation from an Application.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloApplication -ApplicationName App1 | Remove-RavelloApplicationDocumentation</dev:code> <dev:remarks> <maml:para>Removes the Documentation from the Application, named App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloApplicationVm</command:name> <maml:description> <maml:para>Remove a VM from an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloApplicationVm</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Removes a VM from an Application</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloApplicationVm -ApplicationName App1 -VmName VM1</dev:code> <dev:remarks> <maml:para>Removes the VM named VM1 from the Application named App1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloBlueprint</command:name> <maml:description> <maml:para>Remove a Blueprint</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloBlueprint</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove a Blueprint from the library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloBlueprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloBlueprint -BlueprintName BP1</dev:code> <dev:remarks> <maml:para>Remove the Blueprint named BP1 from the library</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloBlueprintDocumentation</command:name> <maml:description> <maml:para>Remove Documentation from a Blueprint</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloBlueprintDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove the Documentation from a Blueprint</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloBlueprintDocumentation -BlueprintName BP1</dev:code> <dev:remarks> <maml:para>Removes the Documentation from the Blueprint named BP1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloDiskImage</command:name> <maml:description> <maml:para>Remove a Disk Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloDiskImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove a Disk Image from the library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloDiskImage -DiskImageName Disk1</dev:code> <dev:remarks> <maml:para>Removes a Disk Image named Disk1 from the library</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloDiskImageDocumentation</command:name> <maml:description> <maml:para>Remove Documentation from a Disk Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloDiskImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove the Documentation from a Disk Image in the Library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloDiskImageDocumentation -DiskImageName Disk1</dev:code> <dev:remarks> <maml:para>Removes the documentation from the Disk Image named Disk1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloElasticIP</command:name> <maml:description> <maml:para>Remove an Elastic IP from the Library</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloElasticIP</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove an Elastic IP from the Library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloElasticIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ip"> <maml:name>ElasticIpAddress</maml:name> <maml:description> <maml:para>The IP address of the Elastic IP to be removed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ip"> <maml:name>ElasticIpAddress</maml:name> <maml:description> <maml:para>The IP address of the Elastic IP 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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloElasticIP -ElasticIpAddress 192.168.1.1</dev:code> <dev:remarks> <maml:para>Removes the Elastic Ip with the IP address 192.168.1.1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloElasticIP | where{$_.Location -eq 'Sydney'} | Remove-RavelloElasticIP</dev:code> <dev:remarks> <maml:para>Remove all the Elastic Ip entries that where defined in the 'Sydney' IP pool</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloEphemeralAccessToken</command:name> <maml:description> <maml:para>Remove an Ephemeral Access Token</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloEphemeralAccessToken</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove an Ephemeral Access Token from the library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloEphemeralAccessToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloEphemeralAccessToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloEphemeralAccessToken -EphemeralAccessTokenName EAT1</dev:code> <dev:remarks> <maml:para>Removes the Ephemeral Access Token named EAT1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloEphemeralAccessToken | where{$_.expirationTime -lt (Get-Date)} | Remove-RavelloEphemeralAccessToken</dev:code> <dev:remarks> <maml:para>The example removes all expired Ephemeral Access Tokes</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloImage</command:name> <maml:description> <maml:para>Remove an Image Remove-RavelloImage -ImageId <long> [<CommonParameters>] Remove-RavelloImage -ImageName <string> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove an Image from the Library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloImage -ImageName VM1</dev:code> <dev:remarks> <maml:para>Remove an Image (VM) from the Library</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloImageDocumentation</command:name> <maml:description> <maml:para>Remove Documentation from an Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove the Documentation from an Image in the Library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloImageDocumentation -ImageName VM1</dev:code> <dev:remarks> <maml:para>Removes the Documentation from an Image named VM1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloKeyPair</command:name> <maml:description> <maml:para>Remove a Key Pair</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloKeyPair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove a Key Pair from the Library</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>KeyPairId</maml:name> <maml:description> <maml:para>The ID of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>KeyPairId</maml:name> <maml:description> <maml:para>The ID of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloKeyPair -KeyPairName KP1</dev:code> <dev:remarks> <maml:para>Removes a Key Pair, named KP1, from the Library</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloPermissionsGroup</command:name> <maml:description> <maml:para>Remove a Permission Group or a User from a Permission Group Remove-RavelloPermissionsGroup -UserId <long> [-PermissionGroupId <long>] [-PermissionGroupName <string>] [<CommonParameters>] Remove-RavelloPermissionsGroup -UserName <string> [-PermissionGroupId <long>] [-PermissionGroupName <string>] [<CommonParameters>] Remove-RavelloPermissionsGroup -PermissionGroupId <long> [-UserId <long>] [-UserName <string>] [<CommonParameters>] Remove-RavelloPermissionsGroup -PermissionGroupName <string> [-UserId <long>] [-UserName <string>] [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloPermissionsGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove a Permission Group or a User from a Permission Group</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloPermissionsGroup -PermissionGroupName PG1</dev:code> <dev:remarks> <maml:para>Remove a Permission Group named PG1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloPermissionsGroup -PermissionGroupName PG1 -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>Remove a User, named John Doe, from a Permission Group, named PG1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloTask</command:name> <maml:description> <maml:para/> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloTask</command:noun> <dev:version/> </command:details> <maml:description> <maml:para/> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloTask -ApplicationName App1</dev:code> <dev:remarks> <maml:para>Remove all Tasks from an Application, named App1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$appName = 'App1' Get-RavelloApplication -ApplicationName $appName | Get-RavelloTask | where{$_.action -eq 'START'} | %{ Remove-RavelloTask -ApplicationName $appName }</dev:code> <dev:remarks> <maml:para>Remove all Tasks of actiontype START from an Application, named App1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloUser</command:name> <maml:description> <maml:para>Remove a User from the Organization</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloUser</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove a User from the Organization</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RavelloUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-RavelloUser -FirstName John -LastName Doe</dev:code> <dev:remarks> <maml:para>Removes a user, named John Doe, from the Organization</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUser -FirstName John -LastName Doe | Remove-RavelloUser</dev:code> <dev:remarks> <maml:para>Removes a user, named John Doe, from the Organization</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-RavelloUserAlert</command:name> <maml:description> <maml:para>Unregister a User from an Alert</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RavelloUserAlert</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Unregister a User from an Alert</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-RavelloUserAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EventId</maml:name> <maml:description> <maml:para>The ID of the Event</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EventId</maml:name> <maml:description> <maml:para>The ID of the Event</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloUserAlert | where{$_.eventName -eq 'LOGOUT'} | Remove-RavelloUserAlert</dev:code> <dev:remarks> <maml:para>This removes the User Alert for the LOGOUT Events.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Revoke-RavelloShare</command:name> <maml:description> <maml:para>Revoke a Share</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Revoke</command:verb> <command:noun>RavelloShare</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Unshare a specific Share</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Revoke-RavelloShare</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="id"> <maml:name>ShareId</maml:name> <maml:description> <maml:para>The ID of the Share</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="id"> <maml:name>ShareId</maml:name> <maml:description> <maml:para>The ID of the Share</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloShare -ResourceType BLUEPRINT | Revoke-RavelloShare</dev:code> <dev:remarks> <maml:para>Remove all existing Shares to any Blueprint resource</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloApplication</command:name> <maml:description> <maml:para>Change Application Name and/or Description</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloApplication</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Make changes to an Application. The current version allows to change the Name and the Description of the APplication</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewApplicationName</maml:name> <maml:description> <maml:para>The new Name of the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewApplicationName</maml:name> <maml:description> <maml:para>The new Name of the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewApplicationName</maml:name> <maml:description> <maml:para>The new Name of the Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloApplication -ApplicationName App1 -NewApplicationName MyApp1 -NewDescription 'Changed Description'</dev:code> <dev:remarks> <maml:para>This will change the name of Application, named App1, into MyApp1. And it will change the Description.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloApplicationDocumentation</command:name> <maml:description> <maml:para>Change the Documentation of an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloApplicationDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change the Documentation of an Application. Note that the Application must have documentation present for this cmdlet. If there is no Documentation present, use the New-RavelloApplicationDcoumentation cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$doc = @" New text "@ Set-RavelloApplicationDocumentation -ApplicationName App1 -Documentation $doc</dev:code> <dev:remarks> <maml:para>The example will replace the current Documemtation with the text in the $doc variable</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloApplicationTimeout</command:name> <maml:description> <maml:para>Set the Application auto-stop timeout</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloApplicationTimeout</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Set the Application auto-stop timeout. The Application will automatically stop when the timeout expires.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloApplicationTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpirationFromNowSeconds</maml:name> <maml:description> <maml:para>Time in seconds for auto-stop timeout</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpirationFromNowSeconds</maml:name> <maml:description> <maml:para>Time in seconds for auto-stop timeout</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpirationFromNowSeconds</maml:name> <maml:description> <maml:para>Time in seconds for auto-stop timeout</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>2 hours</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml: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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloApplicationTimeout</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloApplicationVm</command:name> <maml:description> <maml:para>Change the name and/or description of a VM in an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloApplicationVm</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change the name and/or description of a VM in an Application. Note that this will need a Publish-RavelloApplication to push the change to the Cloud in which the Application is deployed</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text for the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>HostNames</maml:name> <maml:description> <maml:para>Assign one or more hostnames to the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumCpu</maml:name> <maml:description> <maml:para>The number of CPUs</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para>The unit in which the MemorySize parameter is measured. Valid values are GB,MB,KB,BYTE</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySize</maml:name> <maml:description> <maml:para>The memory size. See also the MemorySizeUnit parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text for the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>HostNames</maml:name> <maml:description> <maml:para>Assign one or more hostnames to the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumCpu</maml:name> <maml:description> <maml:para>The number of CPUs</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para>The unit in which the MemorySize parameter is measured. Valid values are GB,MB,KB,BYTE</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySize</maml:name> <maml:description> <maml:para>The memory size. See also the MemorySizeUnit parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text for the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>HostNames</maml:name> <maml:description> <maml:para>Assign one or more hostnames to the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumCpu</maml:name> <maml:description> <maml:para>The number of CPUs</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para>The unit in which the MemorySize parameter is measured. Valid values are GB,MB,KB,BYTE</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySize</maml:name> <maml:description> <maml:para>The memory size. See also the MemorySizeUnit parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text for the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>HostNames</maml:name> <maml:description> <maml:para>Assign one or more hostnames to the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumCpu</maml:name> <maml:description> <maml:para>The number of CPUs</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para>The unit in which the MemorySize parameter is measured. Valid values are GB,MB,KB,BYTE</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySize</maml:name> <maml:description> <maml:para>The memory size. See also the MemorySizeUnit parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name 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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description text for the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>HostNames</maml:name> <maml:description> <maml:para>Assign one or more hostnames to the VM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumCpu</maml:name> <maml:description> <maml:para>The number of CPUs</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para>The unit in which the MemorySize parameter is measured. Valid values are GB,MB,KB,BYTE</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemorySize</maml:name> <maml:description> <maml:para>The memory size. See also the MemorySizeUnit parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloApplicationVm -ApplicationName App1 -VmName VM1 -NewName NewVM1 -NewDescription 'Changed Name' if(Test-RavelloApplicationPendingUpdate -ApplicationName App1) { Publish-RavelloApplication -ApplicationName App1 }</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloApplicationVmIso</command:name> <maml:description> <maml:para>Connect an ISO to a VM</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloApplicationVmIso</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Connect an ISO (Disk Image) to a VM in an Application</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloApplicationVmIso</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>The ID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The Device on which to mount the ISO (Disk Image).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>cdrom</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>The Name 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloApplicationVmIso -ApplicationName App1 -VmName VM1 -DiskImageName Disk1 if(Test-RavelloApplicationPendingUpdate -ApplicationName ThinApp) { Publish-RavelloApplication -ApplicationName ThinApp }</dev:code> <dev:remarks> <maml:para>The Disk Image, named Disk1, is attached to the VM, named VM1, in the Application, named App1. This change will require a Publish of the Application to the Cloud.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloBlueprintDocumentation</command:name> <maml:description> <maml:para>Change the Documentation of a Blueprint</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloBlueprintDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change the Documentation of a Bleuprint. Note that the Blueprint must have documentation present for this cmdlet. If there is no Documentation present, use the New-RavelloBlueprintDcoumentation cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloBlueprintDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>BlueprintId</maml:name> <maml:description> <maml:para>The ID of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BlueprintName</maml:name> <maml:description> <maml:para>The name of the Ravello Blueprint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$doc = @" Sample text "@ Get-RavelloBlueprint -BlueprintName BP1 | Set-RavelloBlueprintDocumentation -Documentation $doc</dev:code> <dev:remarks> <maml:para>Change the Documentation attached to a Blueprint, named BP1, to the text in the $doc variable</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloDiskImage</command:name> <maml:description> <maml:para>Change name,description and size of a Disk Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloDiskImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change name,description and size of a Disk Image</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSizeUnit</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSize</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloDiskImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSizeUnit</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSize</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSizeUnit</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSize</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloDiskImage -DiskImageName Disk1 -NewName Disk2 -NewDescription 'New Size' -NewSizeUnit MB -NewSize 25</dev:code> <dev:remarks> <maml:para>Changes the size of the Disk Image, named Disk1, to the new size of 25 MB. The Description of the Disk Image is changed The Name of the Disk Image is changed from Disk1 to Disk2</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloDiskImageDocumentation</command:name> <maml:description> <maml:para>Change the Documentation of a Disk Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloDiskImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change the Documentation of a Disk Image. Note that the Disk Image must already have documentation present for this cmdlet. If there is no Documentation present, use the New-RavelloDiskImageDocumentation cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloDiskImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>DiskImageId</maml:name> <maml:description> <maml:para>The ID of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskImageName</maml:name> <maml:description> <maml:para>The Name of the Disk Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$doc = @" A new sample text "@ Set-RavelloDiskImageDocumentation -DiskImageName Disk1 -Documentation $doc</dev:code> <dev:remarks> <maml:para>Change the Documentation attached to a Disk Image, named Disk1</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloEphemeralAccessToken</command:name> <maml:description> <maml:para>Change Ephemeral Access Token properties</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloEphemeralAccessToken</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change a selected set of properties of an Ephemeral Access Token</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloEphemeralAccessToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for Ephemeral Access Token</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewExpirationTime</maml:name> <maml:description> <maml:para>New DateTime when the object will expire</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>A new description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPermissions</maml:name> <maml:description> <maml:para>The new Permisisons to be assigned to the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloEphemeralAccessToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for Ephemeral Access Token</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewExpirationTime</maml:name> <maml:description> <maml:para>New DateTime when the object will expire</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>A new description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPermissions</maml:name> <maml:description> <maml:para>The new Permisisons to be assigned to the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>EphemeralAccessTokenId</maml:name> <maml:description> <maml:para>The ID of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for Ephemeral Access Token</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewExpirationTime</maml:name> <maml:description> <maml:para>New DateTime when the object will expire</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>A new description of the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPermissions</maml:name> <maml:description> <maml:para>The new Permisisons to be assigned to the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EphemeralAccessTokenName</maml:name> <maml:description> <maml:para>The Name of the Ephemeral Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloEphemeralAccessToken -EphemeralAccessTokenName EAT1 -NewName EAT2 -NewDescription 'New Text' ` -NewExpirationTime (Get-Date).AddDays(14)</dev:code> <dev:remarks> <maml:para>This changes the Epheremal Access Token, named EAT1, to a new name EAT2, the description to "New Text", the expiration date to 14 days from now.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$app = Get-RavelloApplication -ApplicationName App1 $filter = New-RavelloPermissionFilter -Property ID -Operator Equals -Operand $app.id $perm = New-RavelloPermission -ResourceType APPLICATION -Action READ,EXECUTE -FilterOperand Or -Filter $filter Set-RavelloEphemeralAccessToken -EphemeralAccessTokenName EAT1 -NewPermissions $perm</dev:code> <dev:remarks> <maml:para>This changes the permissions for the Ephemeral Access Token, named EAT1. The new permission gives READ and Execute permissions to an Application, named App1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloImage</command:name> <maml:description> <maml:para/> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloImage</command:noun> <dev:version/> </command:details> <maml:description> <maml:para/> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumCpu</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemorySize</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumCpu</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemorySize</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumCpu</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemorySizeUnit</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemorySize</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml: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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloImage -ImageName VM1 -NumCpu 2 -MemorySize 4 -MemorySizeUnit GB</dev:code> <dev:remarks> <maml:para>Changes the configuration of the VM, named VM1, to 2 CPUs and 4GB of memory.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloImageDocumentation</command:name> <maml:description> <maml:para>Change the Documentation of an Image</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloImageDocumentation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change the Documentation of an Image. Note that the Image must already have documentation present for this cmdlet. If there is no Documentation present, use the New-RavelloImageDocumentation cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloImageDocumentation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>The ID of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>Documentation attached to the object</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>The Name of the Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$doc = @" New text "@ Set-RavelloImageDocumentation -ImageName Image1 -Documentation $doc</dev:code> <dev:remarks> <maml:para>Changes the existing documentation attached to the Image, named Image1, to the content of the $doc variable</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloKeyPair</command:name> <maml:description> <maml:para>Change a Key Pair</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloKeyPair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change a Key Pair. Currently only the name of the Key Pair can be changed</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>KeyPairId</maml:name> <maml:description> <maml:para>The ID of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the Key Pair</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloKeyPair</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the Key Pair</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>KeyPairId</maml:name> <maml:description> <maml:para>The ID of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name of the Key Pair</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyPairName</maml:name> <maml:description> <maml:para>The Name of the KeyPair</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloKeyPair</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloOrganization</command:name> <maml:description> <maml:para>Change the Organization name</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloOrganization</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change the name of the Organization.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloOrganization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The ID of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewOrganizationName</maml:name> <maml:description> <maml:para>The new Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloOrganization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewOrganizationName</maml:name> <maml:description> <maml:para>The new Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The ID of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewOrganizationName</maml:name> <maml:description> <maml:para>The new Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The Name of the Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloOrganization -OraganizationName Org1 -NewOrganizationName NewOrg</dev:code> <dev:remarks> <maml:para>Changes the name of the Organization from Org1 to NewOrg</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloPermissionsGroup</command:name> <maml:description> <maml:para>Change a Permission Group</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloPermissionsGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change a set of properties of a Permission Group</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new Name of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPermissions</maml:name> <maml:description> <maml:para>The new Permissions of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloPermissionsGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new Name of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPermissions</maml:name> <maml:description> <maml:para>The new Permissions of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>PermissionGroupId</maml:name> <maml:description> <maml:para>The ID of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new Name of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new Description of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPermissions</maml:name> <maml:description> <maml:para>The new Permissions of the Permission Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Internal switch that is used to ask for "raw" objects to be returned (no DateTime convertion)</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PermissionGroupName</maml:name> <maml:description> <maml:para>The Name of the PermissionGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloPermissionsGroup -PermissionGroupName PG1 -NewName PGNew1 -NewDescription 'A new description'</dev:code> <dev:remarks> <maml:para>Changes the Name and Description of a Permission Group, named PG1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$app = Get-RavelloApplication -ApplicationName App1 $filter = New-RavelloPermissionFilter -Property ID -Operator Equals -Operand $app.id $perm = New-RavelloPermission -ResourceType APPLICATION -Action READ,UPDATE,EXECUTE -FilterOperand Or -Filter $filter Set-RavelloPermissionsGroup -PermissionGroupName PG1 -NewPermissions $perm</dev:code> <dev:remarks> <maml:para>Changes the Permission Group permissions. The new permissions are the Application, named App1, and allow READ,UPDATE and EXECUTE actions</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloTask</command:name> <maml:description> <maml:para>Change a Task</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloTask</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change properties of a Task.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new description of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewStart</maml:name> <maml:description> <maml:para>The new Start datetime of the period where the Task is enabled</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFinish</maml:name> <maml:description> <maml:para>The new Finish datetime of the period where the Task is enabled</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewCron</maml:name> <maml:description> <maml:para>The new Cron expression of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>The ID of the Task</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new description of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewStart</maml:name> <maml:description> <maml:para>The new Start datetime of the period where the Task is enabled</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFinish</maml:name> <maml:description> <maml:para>The new Finish datetime of the period where the Task is enabled</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewCron</maml:name> <maml:description> <maml:para>The new Cron expression of the Task</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-RavelloTask -ApplicationName App1 | where{$_.action -eq 'BLUEPRINT'} | Set-RavelloTask -NewStart (Get-Date).AddDays(7) -NewDescription 'New Text'</dev:code> <dev:remarks> <maml:para>Changes the Save as Blueprint Task attached to an Application, named App1. The start of the period during which the Task is enabled is changed to 7 days from now. The text of the Description is changed</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-RavelloUserPassword</command:name> <maml:description> <maml:para>Change a User password</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RavelloUserPassword</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change a User password</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-RavelloUserPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The current password for the Ravello user account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>The new password for the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RavelloUserPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The current password for the Ravello user account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>The new password for the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The ID of the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The current password for the Ravello user account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>The new password for the User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>The Last Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>The First Name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloUserPassword -FirstName John -LastName Doe -Password pswd123 -NewPassword newpswd123</dev:code> <dev:remarks> <maml:para>Change the password for the User, named John doe, to the new password.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Test-RavelloApplicationPendingUpdate</command:name> <maml:description> <maml:para>Test if there are pending updates for an Application</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>RavelloApplicationPendingUpdate</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>When changes are made to components of an Application, the updates need to be pushed to the Application that was deployed to the Cloud. This cmdlet will return what changes are made that were not yet pushed to the cloud.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-RavelloApplicationPendingUpdate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-RavelloApplicationPendingUpdate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplicationName</maml:name> <maml: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/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-RavelloApplicationVm -ApplicationName App1 -VmName VM1 -NewName NewVM1 -NewDescription 'Changed Name' if(Test-RavelloApplicationPendingUpdate -ApplicationName App1) { Publish-RavelloApplication -ApplicationName App1 }</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Test-RavelloApplicationPublished</command:name> <maml:description> <maml:para>Test if an Application is published to the CLoud</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>RavelloApplicationPublished</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Test if an Application is published to the Cloud. For the creation of an Application, after the Design phase, the Deployment pahse has to follow. It's this Deployment phase that sets up the Designed Application in the Cloud.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-RavelloApplicationPublished</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-RavelloApplicationPublished</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="id"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ID of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>The name of the Ravello Application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-RavelloApplicationPublished -ApplicationName App1</dev:code> <dev:remarks> <maml:para>The test will return $true or $false, depending if all design changes have been pushed to the cloud</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> </helpItems> |