en-US/Armor-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-Armor</command:name> <command:verb>Connect</command:verb> <command:noun>Armor</command:noun> <maml:description> <maml:para>Connects to the Armor API and establishes a session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connects to the Armor RESTful API and supplies credentials to the method. The Armor API then returns a unique, temporary authorization code, which is then converted into a token to represent the user's credentials for subsequent calls. Last, the account context is set. If an account ID is not specified, one is automatically selected from the list of authorized account IDs. Returns the session details which are stored in the variable: $Global:ArmorSession.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-Armor</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Your Armor API username and password. If not supplied as a parameter, you will be prompted for your credentials.</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>( Get-Credential )</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>AccountID</maml:name> <maml:Description> <maml:para>Specifies the Armor account ID to use for all subsequent requests. The permitted range is 1-65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Armor API server IP address or FQDN.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Api.armor.com</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the Armor API server listening TCP port. The permitted range is: 1-65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request. The specified value is also set as the default API version for the session as a parameter of the session variable: '$Global:ArmorSession.ApiVersion'.</maml:para> <maml:para>The API version can be specified when any other public cmdlets are called or the value of '$Global:ArmorSession.ApiVersion' can be updated afterward to set a different default API version for the session.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>V1.0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Your Armor API username and password. If not supplied as a parameter, you will be prompted for your credentials.</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>( Get-Credential )</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>AccountID</maml:name> <maml:Description> <maml:para>Specifies the Armor account ID to use for all subsequent requests. The permitted range is 1-65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Armor API server IP address or FQDN.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Api.armor.com</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the Armor API server listening TCP port. The permitted range is: 1-65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request. The specified value is also set as the default API version for the session as a parameter of the session variable: '$Global:ArmorSession.ApiVersion'.</maml:para> <maml:para>The API version can be specified when any other public cmdlets are called or the value of '$Global:ArmorSession.ApiVersion' can be updated afterward to set a different default API version for the session.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>V1.0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None- this function does not accept pipeline inputs.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorSession</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Connect-Armor</dev:code> <dev:remarks> <maml:para>Prompts for the username and password, and then attempts to log into the Armor API.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Connect-Armor -Credential $pscredential</dev:code> <dev:remarks> <maml:para>Attempts to log into the Armor API with the credentials stored in the $pscredential object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Connect-Armor -Credential $pscredential -AccountID 12345</dev:code> <dev:remarks> <maml:para>Attempts to log into the Armor API with the credentials stored in the $pscredential object, and sets the account context to '12345'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Connect-Armor -Credential $pscredential -ApiVersion 'v1.0'</dev:code> <dev:remarks> <maml:para>Attempts to log into the Armor API with the credentials stored in the $pscredential object and sets the specified API version as the default for the session, which is stored in $Global:ArmorSession.ApiVersion.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Connect-Armor -Credential $pscredential -Server 'localhost' -Port 8443</dev:code> <dev:remarks> <maml:para>Attempts to log into a local test/dev Armor API instance listening on port 8443/tcp with the credentials stored in the $pscredential object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Connect-Armor/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Connect-Armor/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Connect-Armor.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Connect-Armor.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Log+into+Armor+API</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Log+into+Armor+API</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Post+Authorize</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Post+Authorize</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Post+Token</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Post+Token</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Authenticated+User+Info</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Authenticated+User+Info</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Authentication/TenantOAuth_AuthorizeAsync</maml:linkText> <maml:uri>https://developer.armor.com/#!/Authentication/TenantOAuth_AuthorizeAsync</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Authentication/TenantOAuth_TokenAsync</maml:linkText> <maml:uri>https://developer.armor.com/#!/Authentication/TenantOAuth_TokenAsync</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Authentication/Me_GetMeAsync</maml:linkText> <maml:uri>https://developer.armor.com/#!/Authentication/Me_GetMeAsync</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-Armor</command:name> <command:verb>Disconnect</command:verb> <command:noun>Armor</command:noun> <maml:description> <maml:para>Disconnects from Armor and destroys the session information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnects from the Armor API and destroys the $Global:ArmorSession session variable.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-Armor</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None- this function does not accept pipeline inputs.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Disconnect-Armor</dev:code> <dev:remarks> <maml:para>Disconnects from the Armor API and destroys the $Global:ArmorSession session variable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Disconnect-Armor/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Disconnect-Armor/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Disconnect-Armor.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Disconnect-Armor.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Armor+API+Guide</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Armor+API+Guide</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/</maml:linkText> <maml:uri>https://developer.armor.com/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorAccount</command:name> <command:verb>Get</command:verb> <command:noun>ArmorAccount</command:noun> <maml:description> <maml:para>Retrieves Armor account details.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a list of Armor account memberships for the currently authenticated user. Returns a set of accounts that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorAccount</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorAccount</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>String</maml:para> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorAccount</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorAccount[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorAccount</dev:code> <dev:remarks> <maml:para>Gets all Armor accounts assigned to the logged in user account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorAccount -Name *Child*</dev:code> <dev:remarks> <maml:para>Gets all Armor accounts assigned to the logged in user account with a name containing the word 'Child'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>1, 'Example Child Account' | Get-ArmorAccount</dev:code> <dev:remarks> <maml:para>Gets the Armor accounts assigned to the logged in user account with ID=1 and Name='Example Child Account' via pipeline values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1 } | Get-ArmorAccount</dev:code> <dev:remarks> <maml:para>Gets the Armor account assigned to the logged in user account with ID=1 via property name in the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'Name' = 'My Secure Account' } | Get-ArmorAccount</dev:code> <dev:remarks> <maml:para>Gets the Armor account assigned to the logged in user account with Name='My Secure Account' via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccount/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccount/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccount.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccount.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Accounts</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Accounts</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Account_Management/Accounts_GetAccounts</maml:linkText> <maml:uri>https://developer.armor.com/#!/Account_Management/Accounts_GetAccounts</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorAccountAddress</command:name> <command:verb>Get</command:verb> <command:noun>ArmorAccountAddress</command:noun> <maml:description> <maml:para>Retrieves the mailing address on file for Armor accounts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the mailing address on file for Armor accounts that your user account has access to.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorAccountAddress</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor account with the desired address details.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.GetAccountContextID()</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor account with the desired address details.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.GetAccountContextID()</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorAccountAddress</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorAccountAddress</dev:code> <dev:remarks> <maml:para>Retrieves the mailing address of the Armor account currently in context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorAccountAddress -ID 1</dev:code> <dev:remarks> <maml:para>Retrieves the mailing address of the Armor account with ID 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>1, 2 | Get-ArmorAccountAddress</dev:code> <dev:remarks> <maml:para>Retrieves the mailing address of the Armor accounts with ID=1 and ID=2 via pipeline values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1 } | Get-ArmorAccountAddress</dev:code> <dev:remarks> <maml:para>Retrieves the mailing address of the Armor account with ID=1 and ID=2 via property names in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccountAddress/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccountAddress/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccountAddress.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccountAddress.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Account</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Account</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Account_Management/Accounts_GetAccount</maml:linkText> <maml:uri>https://developer.armor.com/#!/Account_Management/Accounts_GetAccount</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorAccountContext</command:name> <command:verb>Get</command:verb> <command:noun>ArmorAccountContext</command:noun> <maml:description> <maml:para>Retrieves the Armor Anywhere or Armor Complete account currently in context.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If your user account has access to more than one Armor Anywhere and/or Armor Complete accounts, this cmdlet allows you to get the current context, which all future requests will reference.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorAccountContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None- this function does not accept pipeline inputs</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorAccount</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorAccountContext</dev:code> <dev:remarks> <maml:para>Retrieves the Armor account currently in context.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccountContext/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccountContext/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccountContext.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccountContext.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Log+into+Armor+API</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Log+into+Armor+API</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/</maml:linkText> <maml:uri>https://developer.armor.com/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorCompleteDatacenter</command:name> <command:verb>Get</command:verb> <command:noun>ArmorCompleteDatacenter</command:noun> <maml:description> <maml:para>Retrieves Armor Complete datacenter details.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves details about the Armor Complete datacenters, regions, and compute zones. Returns a set of datacenters that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorCompleteDatacenter</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete datacenter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorCompleteDatacenter</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor Complete region.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorCompleteDatacenter</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor Complete datacenter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete datacenter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor Complete region.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor Complete datacenter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>String</maml:para> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteDatacenter[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorCompleteDatacenter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorCompleteDatacenter</dev:code> <dev:remarks> <maml:para>Retrieves the details for all Armor Complete datacenters.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorCompleteDatacenter -ID 2</dev:code> <dev:remarks> <maml:para>Retrieves the details for the Armor Complete datacenter with ID=2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>1, 'PHX01' | Get-ArmorCompleteDatacenter</dev:code> <dev:remarks> <maml:para>Retrieves the details for the Armor Complete datacenter with ID=1 and Location='PHX01' via pipeline values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'Location' = 'EU West' } | Get-ArmorCompleteDatacenter</dev:code> <dev:remarks> <maml:para>Retrieves the details for the Armor Complete datacenter with Name='EU West' via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorCompleteDatacenter/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorCompleteDatacenter/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorCompleteDatacenter.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorCompleteDatacenter.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Locations</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Locations</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Location_Get</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Location_Get</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorCompleteWorkload</command:name> <command:verb>Get</command:verb> <command:noun>ArmorCompleteWorkload</command:noun> <maml:description> <maml:para>Retrieves Armor Complete workloads.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Workloads and tiers are logical grouping tools for helping you organize your virtual machines and corresponding resources in your Armor Complete software-defined datacenters.</maml:para> <maml:para>Workloads contain tiers, and tiers contain virtual machines.</maml:para> <maml:para>Workloads are intended to help you describe the business function of a group of servers, such as 'My Secure Website', which could be useful for chargeback or showback to your customers, as well as helping your staff and the Armor Support teams understand the architecture of your environment.</maml:para> <maml:para>Tiers are intended to describe the application tiers within each workload. A typical three tiered application workload is comprised of presentation, business logic, and persistence tiers. Common labels for each are: web, application, and database respectively, but you can group your VMs however you choose.</maml:para> <maml:para>Returns a set of workloads that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorCompleteWorkload</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorCompleteWorkload</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>String</maml:para> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkload[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkload</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorCompleteWorkload</dev:code> <dev:remarks> <maml:para>Retrieves the details for all workloads in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorCompleteWorkload -ID 1</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload with ID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorCompleteWorkload -Name 'LAMP stack'</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload with Name='LAMP stack'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>2, 'WISP stack' | Get-ArmorCompleteWorkload -ApiVersion 'v1.0'</dev:code> <dev:remarks> <maml:para>Retrieves the API version 1.0 details for the workloads with ID=2 and Name='WISP stack' via pipeline values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'Name' = 'Secure stack' } | Get-ArmorCompleteWorkload</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload with Name='Secure stack' via property name in the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1 } | Get-ArmorCompleteWorkload</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload with ID=1 via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorCompleteWorkload/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorCompleteWorkload/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorCompleteWorkload.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorCompleteWorkload.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Workloads</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Workloads</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Workload</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Workload</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/App_GetAppList</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/App_GetAppList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/App_GetAppDetail</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/App_GetAppDetail</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorCompleteWorkloadTier</command:name> <command:verb>Get</command:verb> <command:noun>ArmorCompleteWorkloadTier</command:noun> <maml:description> <maml:para>Retrieves tiers in an Armor Complete workload.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Workloads and tiers are logical grouping tools for helping you organize your virtual machines and corresponding resources in your Armor Complete software-defined datacenters.</maml:para> <maml:para>Workloads contain tiers, and tiers contain virtual machines.</maml:para> <maml:para>Workloads are intended to help you describe the business function of a group of servers, such as 'My Secure Website', which could be useful for chargeback or showback to your customers, as well as helping your staff and the Armor Support teams understand the architecture of your environment.</maml:para> <maml:para>Tiers are intended to describe the application tiers within each workload. A typical three tiered application workload is comprised of presentation, business logic, and persistence tiers. Common labels for each are: web, application, and database respectively, but you can group your VMs however you choose.</maml:para> <maml:para>Returns a set of tiers in a workload that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorCompleteWorkloadTier</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload that contains the tier(s).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorCompleteWorkloadTier</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload that contains the tier(s).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the workload tiers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload that contains the tier(s).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the workload tiers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>String</maml:para> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkloadTier[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkloadTier</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorCompleteWorkloadTier -WorkloadID 1</dev:code> <dev:remarks> <maml:para>Retrieves the details for all workload tiers in the workload with WorkloadID=1 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorCompleteWorkloadTier -WorkloadID 1 -ID 1</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload tier with ID=1 in the workload with WorkloadID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorCompleteWorkloadTier -WorkloadID 1 -Name 'Database'</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload tier with Name='Database' in the workload with WorkloadID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>2, 3 | Get-ArmorCompleteWorkloadTier -ApiVersion 'v1.0'</dev:code> <dev:remarks> <maml:para>Retrieves the API version 1.0 details for all of the workload tiers in workloads with WorkloadID=2 and WorkloadID=3 via pipeline values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'WorkloadID' = 1; 'ID' = 1 } | Get-ArmorCompleteWorkloadTier</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload tier with ID=1 in the workload with WorkloadID=1 via property names in the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'WorkloadID' = 1; 'Name' = 'Presentation' } | Get-ArmorCompleteWorkloadTier</dev:code> <dev:remarks> <maml:para>Retrieves the details for the workload tier with Name='Presentation' in the workload with WorkloadID=1 via property names in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorCompleteWorkloadTier/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorCompleteWorkloadTier/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorCompleteWorkloadTier.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorCompleteWorkloadTier.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Tiers</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Tiers</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Tier</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Tier</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Tier_GetAppTiers</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Tier_GetAppTiers</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Tier_Get</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Tier_Get</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorIdentity</command:name> <command:verb>Get</command:verb> <command:noun>ArmorIdentity</command:noun> <maml:description> <maml:para>Retrieves identity details about your Armor user account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves details about your Armor user account that you used to establish the session, including account membership and permissions.</maml:para> <maml:para>This also updates the identity information in the session variable: $Global:ArmorSession.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorIdentity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None- this function does not accept pipeline inputs.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorSession</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorIdentity</dev:code> <dev:remarks> <maml:para>Retrieves the identity details about your Armor user account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorIdentity -ApiVersion 1.0</dev:code> <dev:remarks> <maml:para>Retrieves the Armor API version 1.0 identity details about your Armor user account.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorIdentity/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorIdentity/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorIdentity.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorIdentity.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Authenticated+User+Info</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Authenticated+User+Info</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Authentication/Me_GetMeAsync</maml:linkText> <maml:uri>https://developer.armor.com/#!/Authentication/Me_GetMeAsync</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorUser</command:name> <command:verb>Get</command:verb> <command:noun>ArmorUser</command:noun> <maml:description> <maml:para>Retrieves Armor user account details.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves details about the user accounts in the Armor Anywhere or Armor Complete account in context. Returns a set of user accounts that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor user account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorUser</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>Specifies the username of the Armor 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:Description> <maml:para>Specifies the first name of the Armor 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:Description> <maml:para>Specifies the last name of the Armor 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor user account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>Specifies the username of the Armor 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:Description> <maml:para>Specifies the first name of the Armor 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:Description> <maml:para>Specifies the last name of the Armor 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>String</maml:para> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorUser[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorUser</dev:code> <dev:remarks> <maml:para>Retrieves the details for all user accounts in the Armor account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorUser -ID 1</dev:code> <dev:remarks> <maml:para>Retrieves the details for all user accounts in the Armor account that currently has context.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorUser/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorUser/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorUser.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorUser.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+Users</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+Users</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+User</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+User</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Account_Management/Users_GetUsers</maml:linkText> <maml:uri>https://developer.armor.com/#!/Account_Management/Users_GetUsers</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Account_Management/Users_GetUser</maml:linkText> <maml:uri>https://developer.armor.com/#!/Account_Management/Users_GetUser</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ArmorVM</command:name> <command:verb>Get</command:verb> <command:noun>ArmorVM</command:noun> <maml:description> <maml:para>Retrieves Armor Complete and Armor Anywhere virtual machine details.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves details about the virtual machines in the Armor Anywhere or Armor Complete account in context. Returns a set of virtual machines that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ArmorVM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the IDs of the virtual machines that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorVM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>CoreInstanceID</maml:name> <maml:Description> <maml:para>Specifies the Armor Anywhere Core Agent instance IDs of the virtual machines that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ArmorVM</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the virtual machines that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the IDs of the virtual machines that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>CoreInstanceID</maml:name> <maml:Description> <maml:para>Specifies the Armor Anywhere Core Agent instance IDs of the virtual machines that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the virtual machines that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>Guid</maml:para> <maml:para>String</maml:para> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorVM[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ArmorVM</dev:code> <dev:remarks> <maml:para>Retrieves the details for all VMs in the Armor account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ArmorVM -ID 1</dev:code> <dev:remarks> <maml:para>Retrieves the details for the VM with ID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorVM -Name 'web1'</dev:code> <dev:remarks> <maml:para>Retrieves the details for the VM with Name='web1'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-ArmorVM -Name db*</dev:code> <dev:remarks> <maml:para>Retrieves all VMs in the Armor account that currently has context that have a name that starts with 'db'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>1 | Get-ArmorVM</dev:code> <dev:remarks> <maml:para>Retrieves the details for the VM with ID=1 via pipeline value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>'*secure*' | Get-ArmorVM</dev:code> <dev:remarks> <maml:para>Retrieves all VMs containing the word 'secure' in the name via pipeline value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1 } | Get-ArmorVM</dev:code> <dev:remarks> <maml:para>Retrieves the details for the VM with ID=1 via property name in the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'Name' = 'app1' } | Get-ArmorVM</dev:code> <dev:remarks> <maml:para>Retrieves the details for the VM with Name='app1' via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorVM/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorVM/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorVM.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorVM.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+VMs</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+VMs</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Get+VM+Detail</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Get+VM+Detail</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_GetVmList</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_GetVmList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_GetVmDetail</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_GetVmDetail</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-ArmorWebRequest</command:name> <command:verb>Invoke</command:verb> <command:noun>ArmorWebRequest</command:noun> <maml:description> <maml:para>Sends custom requests to Armor API endpoints.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sends custom HTTPS requests to the Armor API. It can be used for calling API endpoints that are not yet covered by the cmdlets in this module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-ArmorWebRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>Specifies the Armor API endpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Headers</maml:name> <maml:Description> <maml:para>Specifies the headers of the Armor API web request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.Headers</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Method</maml:name> <maml:Description> <maml:para>Specifies the method used for the Armor API web request. The permitted values are: - Delete</maml:para> <maml:para>- Get</maml:para> <maml:para>- Patch</maml:para> <maml:para>- Post</maml:para> <maml:para>- Put</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Get</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>Specifies the body of the Armor API web request. This parameter is ignored for Get requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>SuccessCode</maml:name> <maml:Description> <maml:para>Specifies the value of the HTTP response code that indicates success for this Armor API web request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>If the PowerShell $ConfirmPreference value is elevated for this Armor API web request by setting the -Confirm parameter to $true, this specifies the text to display at the user prompt.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Test Armor API request</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>Specifies the Armor API endpoint.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Headers</maml:name> <maml:Description> <maml:para>Specifies the headers of the Armor API web request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.Headers</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Method</maml:name> <maml:Description> <maml:para>Specifies the method used for the Armor API web request. The permitted values are: - Delete</maml:para> <maml:para>- Get</maml:para> <maml:para>- Patch</maml:para> <maml:para>- Post</maml:para> <maml:para>- Put</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Get</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>Specifies the body of the Armor API web request. This parameter is ignored for Get requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>SuccessCode</maml:name> <maml:Description> <maml:para>Specifies the value of the HTTP response code that indicates success for this Armor API web request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>200</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>If the PowerShell $ConfirmPreference value is elevated for this Armor API web request by setting the -Confirm parameter to $true, this specifies the text to display at the user prompt.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Test Armor API request</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-ArmorWebRequest -Endpoint '/me'</dev:code> <dev:remarks> <maml:para>Retrieves the current user's identity details.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-ArmorWebRequest -Endpoint '/vms' -Headers $Global:ArmorSession.Headers</dev:code> <dev:remarks> <maml:para>Retrieves VM details using the session headers.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Invoke-ArmorWebRequest/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Invoke-ArmorWebRequest/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Invoke-ArmorWebRequest.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Invoke-ArmorWebRequest.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Armor+API+Guide</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Armor+API+Guide</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/</maml:linkText> <maml:uri>https://developer.armor.com/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ArmorCompleteWorkloadTier</command:name> <command:verb>New</command:verb> <command:noun>ArmorCompleteWorkloadTier</command:noun> <maml:description> <maml:para>Creates tiers in an Armor Complete workload.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Workloads and tiers are logical grouping tools for helping you organize your virtual machines and corresponding resources in your Armor Complete software-defined datacenters.</maml:para> <maml:para>Workloads contain tiers, and tiers contain virtual machines.</maml:para> <maml:para>Workloads are intended to help you describe the business function of a group of servers, such as 'My Secure Website', which could be useful for chargeback or showback to your customers, as well as helping your staff and the Armor Support teams understand the architecture of your environment.</maml:para> <maml:para>Tiers are intended to describe the application tiers within each workload. A typical three tiered application workload is comprised of presentation, business logic, and persistence tiers. Common labels for each are: web, application, and database respectively, but you can group your VMs however you choose.</maml:para> <maml:para>Returns a set of tiers in a workload that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ArmorCompleteWorkloadTier</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload that contains the tier(s).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload that contains the tier(s).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>String</maml:para> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkloadTier[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkloadTier</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-ArmorCompleteWorkloadTier -WorkloadID 1 -Name 'presentation'</dev:code> <dev:remarks> <maml:para>Creates a new workload tier named 'presentation' in the workload with WorkloadID=1 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>1, 2 | New-ArmorCompleteWorkloadTier -Name 'business logic' -ApiVersion 'v1.0'</dev:code> <dev:remarks> <maml:para>Creates a new workload tier named 'business logic' in the workloads with WorkloadID=1 and WorkloadID=2 using Armor API version v1.0 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>'web', 'app', 'db' | New-ArmorCompleteWorkloadTier -WorkloadID 1</dev:code> <dev:remarks> <maml:para>Creates new workload tiers named 'web', 'app', and 'db' in the workload with WorkloadID=1 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'WorkloadID' = 1; 'Name' = 'persistence' } | New-ArmorCompleteWorkloadTier</dev:code> <dev:remarks> <maml:para>Creates a new workload tier named 'persistence' in the workload with WorkloadID=1 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/New-ArmorCompleteWorkloadTier/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/New-ArmorCompleteWorkloadTier/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/New-ArmorCompleteWorkloadTier.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/New-ArmorCompleteWorkloadTier.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Create+Tier</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Create+Tier</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Tier_AddTier</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Tier_AddTier</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ArmorCompleteVM</command:name> <command:verb>Remove</command:verb> <command:noun>ArmorCompleteVM</command:noun> <maml:description> <maml:para>Deletes Armor Complete VMs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified VM in the Armor Complete account in context will be deleted.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ArmorCompleteVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VmID"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>IsActive</maml:name> <maml:Description> <maml:para>Confirms that the user is aware of the current state of the Armor Complete VM.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>DeleteNow</maml:name> <maml:Description> <maml:para>Specifies whether the VM should be deleted now or at the end of the billing cycle.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>AccountID</maml:name> <maml:Description> <maml:para>Specifies the Armor account ID to use for all subsequent requests. The permitted range is 1-65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.GetAccountContext().ID</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="5" aliases="UserEmail"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>Specifies the username of the Armor user account. The only accepted value is the current logged in username for meeting the requirements for the v1.0 API request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.User.UserName</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VmID"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>IsActive</maml:name> <maml:Description> <maml:para>Confirms that the user is aware of the current state of the Armor Complete VM.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>DeleteNow</maml:name> <maml:Description> <maml:para>Specifies whether the VM should be deleted now or at the end of the billing cycle.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>AccountID</maml:name> <maml:Description> <maml:para>Specifies the Armor account ID to use for all subsequent requests. The permitted range is 1-65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.GetAccountContext().ID</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="5" aliases="UserEmail"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>Specifies the username of the Armor user account. The only accepted value is the current logged in username for meeting the requirements for the v1.0 API request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.User.UserName</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorVM[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-ArmorCompleteVM -ID 1</dev:code> <dev:remarks> <maml:para>If confirmed and empty of child objects, deletes VM with ID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>1 | Remove-ArmorCompleteVM</dev:code> <dev:remarks> <maml:para>If confirmed and empty of child objects, deletes VM with ID=1 identified via pipeline value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1 | Remove-ArmorCompleteVM</dev:code> <dev:remarks> <maml:para>If confirmed and empty of child objects, deletes workload with ID=1 identified via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Remove-ArmorCompleteVM/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Remove-ArmorCompleteVM/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Remove-ArmorCompleteVM.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Remove-ArmorCompleteVM.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Delete+VM</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Delete+VM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_DeleteVm</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_DeleteVm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ArmorCompleteWorkload</command:name> <command:verb>Remove</command:verb> <command:noun>ArmorCompleteWorkload</command:noun> <maml:description> <maml:para>Deletes Armor Complete workloads.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified workload in the Armor Complete account in context will be deleted if is empty.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ArmorCompleteWorkload</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkload[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkload</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-ArmorCompleteWorkload -ID 1</dev:code> <dev:remarks> <maml:para>If confirmed and empty of child objects, deletes workload with ID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>1 | Remove-ArmorCompleteWorkload</dev:code> <dev:remarks> <maml:para>If confirmed and empty of child objects, deletes workload with ID=1 identified via pipeline value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1 | Remove-ArmorCompleteWorkload</dev:code> <dev:remarks> <maml:para>If confirmed and empty of child objects, deletes workload with ID=1 identified via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Remove-ArmorCompleteWorkload/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Remove-ArmorCompleteWorkload/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Remove-ArmorCompleteWorkload.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Remove-ArmorCompleteWorkload.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Delete+Workload</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Delete+Workload</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/App_DeleteApp</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/App_DeleteApp</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ArmorCompleteWorkloadTier</command:name> <command:verb>Remove</command:verb> <command:noun>ArmorCompleteWorkloadTier</command:noun> <maml:description> <maml:para>Deletes tiers in an Armor Complete workload.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Workloads and tiers are logical grouping tools for helping you organize your virtual machines and corresponding resources in your Armor Complete software-defined datacenters.</maml:para> <maml:para>Workloads contain tiers, and tiers contain virtual machines.</maml:para> <maml:para>Workloads are intended to help you describe the business function of a group of servers, such as 'My Secure Website', which could be useful for chargeback or showback to your customers, as well as helping your staff and the Armor Support teams understand the architecture of your environment.</maml:para> <maml:para>Tiers are intended to describe the application tiers within each workload. A typical three tiered application workload is comprised of presentation, business logic, and persistence tiers. Common labels for each are: web, application, and database respectively, but you can group your VMs however you choose.</maml:para> <maml:para>Returns a set of tiers in a workload that correspond to the filter criteria provided by the cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ArmorCompleteWorkloadTier</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload that contains the tier(s).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload that contains the tier(s).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkloadTier</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-ArmorCompleteWorkloadTier -WorkloadID 1 -ID 1</dev:code> <dev:remarks> <maml:para>Deletes the workload tier with ID=1 in the workload with WorkloadID=1 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>1, 2 | Remove-ArmorCompleteWorkloadTier -WorkloadID 1 -ApiVersion 'v1.0'</dev:code> <dev:remarks> <maml:para>Deletes the workload tiers with ID=1 and ID=2 the workload with WorkloadID=1 using Armor API version v1.0 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'WorkloadID' = 1; 'ID' = 1 } | Remove-ArmorCompleteWorkloadTier</dev:code> <dev:remarks> <maml:para>Deletes the workload tier with ID=1 in the workload with WorkloadID=1 in the Armor Complete account that currently has context.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Remove-ArmorCompleteWorkloadTier/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Remove-ArmorCompleteWorkloadTier/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Remove-ArmorCompleteWorkloadTier.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Remove-ArmorCompleteWorkloadTier.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Delete+Tier</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Delete+Tier</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Tier_DeleteTier</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Tier_DeleteTier</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Rename-ArmorCompleteVM</command:name> <command:verb>Rename</command:verb> <command:noun>ArmorCompleteVM</command:noun> <maml:description> <maml:para>Renames Armor Complete virtual machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified virtual machine in the Armor Complete account in context will be renamed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-ArmorCompleteVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>Specifies the new name for the Armor Complete virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>Specifies the new name for the Armor Complete virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorVM[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Rename-ArmorCompleteVM -ID 1 -NewName TEST-VM</dev:code> <dev:remarks> <maml:para>Renames the VM with ID=1 to 'TEST-VM'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1; 'NewName' = 'TEST-VM' } | Rename-ArmorCompleteVM</dev:code> <dev:remarks> <maml:para>Renames the VM with ID=1 to 'TEST-VM' via property names in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteVM/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteVM/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteVM.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteVM.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Update+VM+Name</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Update+VM+Name</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_UpdateVm</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_UpdateVm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Rename-ArmorCompleteWorkload</command:name> <command:verb>Rename</command:verb> <command:noun>ArmorCompleteWorkload</command:noun> <maml:description> <maml:para>Renames Armor Complete workloads.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified workload in the Armor Complete account in context will be renamed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-ArmorCompleteWorkload</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload that you want to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>Specifies the new name of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload that you want to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>Specifies the new name of the Armor Complete workload.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkload[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkload</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Rename-ArmorCompleteWorkload -ID 1 -NewName TEST-WORKLOAD</dev:code> <dev:remarks> <maml:para>Renames the workload with ID=1 to 'TEST-WORKLOAD'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1; 'NewName' = 'TEST-WORKLOAD' } | Rename-ArmorCompleteWorkload</dev:code> <dev:remarks> <maml:para>Renames the workload with ID=1 to 'TEST-WORKLOAD' via property names in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkload/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkload/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteWorkload.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteWorkload.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Update+Workload</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Update+Workload</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/App_UpdateApp</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/App_UpdateApp</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Rename-ArmorCompleteWorkloadTier</command:name> <command:verb>Rename</command:verb> <command:noun>ArmorCompleteWorkloadTier</command:noun> <maml:description> <maml:para>Renames Armor Complete workload tiers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified workload tier in the Armor Complete account in context will be renamed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-ArmorCompleteWorkloadTier</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload that contains the tier that you want to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload tier to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>Specifies the new name of the Armor Complete workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>WorkloadID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete workload that contains the tier that you want to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the workload tier to rename.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>Specifies the new name of the Armor Complete workload tier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkloadTier[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorCompleteWorkloadTier</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Rename-ArmorCompleteWorkloadTier -ID 1 -NewName TEST-TIER</dev:code> <dev:remarks> <maml:para>Renames the workload tier with ID=1 to 'TEST-TIER'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>[PSCustomObject] @{ 'ID' = 1; 'NewName' = 'TEST-TIER' } | Rename-ArmorCompleteWorkloadTier</dev:code> <dev:remarks> <maml:para>Renames the workload tier with ID=1 to 'TEST-WORKLOAD' via property names in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkloadTier/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkloadTier/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteWorkloadTier.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteWorkloadTier.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Update+Tier</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Update+Tier</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-ArmorCompleteVM</command:name> <command:verb>Reset</command:verb> <command:noun>ArmorCompleteVM</command:noun> <maml:description> <maml:para>Resets Armor Complete virtual machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified virtual machine in the Armor Complete account in context will be hard reset- effectively disconnecting the virtual power cord from the VM, plugging it back in, and then powering it back on. This reboot method has the potential to cause data corruption and should only be used when necessary.</maml:para> <maml:para>See also: Restart-ArmorCompleteVM</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-ArmorCompleteVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to power off & on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to power off & on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorVM[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Reset-ArmorCompleteVM -ID 1</dev:code> <dev:remarks> <maml:para>If confirmed, powers off & on the Armor Complete VM with ID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>1 | Reset-ArmorCompleteVM -Confirm:$false</dev:code> <dev:remarks> <maml:para>Powers off & on the Armor Complete VM with ID=1 via pipeline value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorVM -ID 1 | Reset-ArmorCompleteVM -Confirm:$false</dev:code> <dev:remarks> <maml:para>Powers off & on the Armor Complete VM with ID=1 via property name in the pipeline without confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Reset-ArmorCompleteVM/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Reset-ArmorCompleteVM/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Reset-ArmorCompleteVM.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Reset-ArmorCompleteVM.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restart-ArmorCompleteVM</command:name> <command:verb>Restart</command:verb> <command:noun>ArmorCompleteVM</command:noun> <maml:description> <maml:para>Reboots Armor Complete virtual machines gracefully.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified virtual machine will be gracefully rebooted in the Armor Complete account in context. VMware Tools or open-vm-tools must be installed and running for this request to succeed.</maml:para> <maml:para>See also: Reset-ArmorCompleteVM</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restart-ArmorCompleteVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to gracefully reboot.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to gracefully reboot.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorVM[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Retart-ArmorCompleteVM -ID 1</dev:code> <dev:remarks> <maml:para>Gracefully reboot on the specified Armor Complete VM.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>1 | Retart-ArmorCompleteVM</dev:code> <dev:remarks> <maml:para>Reboot the Armor Complete VM with ID=1 specified via pipeline value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorVM -ID 1 | Retart-ArmorCompleteVM</dev:code> <dev:remarks> <maml:para>Reboot the Armor Complete VM with ID=1 via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Restart-ArmorCompleteVM/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Restart-ArmorCompleteVM/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Restart-ArmorCompleteVM.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Restart-ArmorCompleteVM.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ArmorAccountContext</command:name> <command:verb>Set</command:verb> <command:noun>ArmorAccountContext</command:noun> <maml:description> <maml:para>Sets the Armor Anywhere or Armor Complete account context.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If your user account has access to more than one Armor Anywhere and/or Armor Complete accounts, this cmdlet allows you to update the context, so that all future requests reference the specified account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ArmorAccountContext</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies which Armor account should be used for the context of all subsequent requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies which Armor account should be used for the context of all subsequent requests.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorAccount</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-ArmorAccountContext -ID 1</dev:code> <dev:remarks> <maml:para>Set the account context to the specified account ID so that all subsequent commands reference that account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>2 | Set-ArmorAccountContext</dev:code> <dev:remarks> <maml:para>Set the account context to 2 via the value in the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorAccount -ID 3 | Set-ArmorAccountContext</dev:code> <dev:remarks> <maml:para>Set the account context to 3 via the ID property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Set-ArmorAccountContext/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Set-ArmorAccountContext/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Set-ArmorAccountContext.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Set-ArmorAccountContext.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Log+into+Armor+API</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Log+into+Armor+API</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/</maml:linkText> <maml:uri>https://developer.armor.com/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-ArmorCompleteVM</command:name> <command:verb>Start</command:verb> <command:noun>ArmorCompleteVM</command:noun> <maml:description> <maml:para>Starts Armor Complete virtual machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified virtual machine in the Armor Complete account in context will be powered on.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-ArmorCompleteVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the VM to power on in the Armor Complete account in context.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the VM to power on in the Armor Complete account in context.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorVM[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Start-ArmorCompleteVM -ID 1</dev:code> <dev:remarks> <maml:para>Power on the Armor Complete VM with ID=1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>2 | Start-ArmorCompleteVM</dev:code> <dev:remarks> <maml:para>Power on the Armor Complete VM with ID=2 via pipeline value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorVM -ID 3 | Start-ArmorCompleteVM</dev:code> <dev:remarks> <maml:para>Power on the Armor Complete VM with ID=3 via property name in the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Start-ArmorCompleteVM/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Start-ArmorCompleteVM/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Start-ArmorCompleteVM.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Start-ArmorCompleteVM.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-ArmorCompleteVM</command:name> <command:verb>Stop</command:verb> <command:noun>ArmorCompleteVM</command:noun> <maml:description> <maml:para>Stops Armor Complete virtual machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The specified virtual machine in the Armor Complete account in context will be powered down.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-ArmorCompleteVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to stop.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies how you want to stop the Armor Complete virtual machine.</maml:para> <maml:para>- Shutdown - Initiates a graceful shutdown of the operating system. - VMware Tools or open-vm-tools must be installed, running, and in a good state for this request to succeed. - This is the recommend way to stop your VMs. - Poweroff - Initiates a hard shutdown of the VM- effectively disconnecting the virtual power cord from the VM. - This shutdown method has the potential to cause data corruption. - This should only be used when necessary. - ForceOff - Breaks the state of the environment by marking the VM as powered off in the Armor Management Portal (AMP), but leaves the VM running in the Armor Complete cloud. - This should not be used unless recommended by a Senior Armor Support team member.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Shutdown</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>Specifies the ID of the Armor Complete virtual machine that you want to stop.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies how you want to stop the Armor Complete virtual machine.</maml:para> <maml:para>- Shutdown - Initiates a graceful shutdown of the operating system. - VMware Tools or open-vm-tools must be installed, running, and in a good state for this request to succeed. - This is the recommend way to stop your VMs. - Poweroff - Initiates a hard shutdown of the VM- effectively disconnecting the virtual power cord from the VM. - This shutdown method has the potential to cause data corruption. - This should only be used when necessary. - ForceOff - Breaks the state of the environment by marking the VM as powered off in the Armor Management Portal (AMP), but leaves the VM running in the Armor Complete cloud. - This should not be used unless recommended by a Senior Armor Support team member.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Shutdown</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiVersion</maml:name> <maml:Description> <maml:para>Specifies the API version for this request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Global:ArmorSession.ApiVersion</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>UInt16</maml:name> </dev:type> <maml:description> <maml:para>PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArmorVM[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ArmorVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Troy Lindsay</maml:para> <maml:para>- Twitter: @troylindsay42</maml:para> <maml:para>- GitHub: tlindsay42</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Stop-ArmorCompleteVM -ID 1 -Type Shutdown</dev:code> <dev:remarks> <maml:para>If confirmed, gracefully shutdown the specified Armor Complete VM.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>2 | Stop-ArmorCompleteVM -Type Poweroff -Confirm:$false</dev:code> <dev:remarks> <maml:para>Power off the Armor Complete VM with ID=2 via pipeline value without prompting for confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ArmorVM -ID 3 | Stop-ArmorCompleteVM -Type ForceOff -Confirm:$false</dev:code> <dev:remarks> <maml:para>Break the state of the Armor Complete VM with ID=3 via parameter name in the pipeline without prompting for confirmation, so that the VM appears to be powered off in the Armor Management Portal (AMP), but is still powered on in the Armor Complete cloud.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://tlindsay42.github.io/ArmorPowerShell/public/Stop-ArmorCompleteVM/</maml:linkText> <maml:uri>https://tlindsay42.github.io/ArmorPowerShell/public/Stop-ArmorCompleteVM/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Stop-ArmorCompleteVM.ps1</maml:linkText> <maml:uri>https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Stop-ArmorCompleteVM.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:linkText> <maml:uri>https://docs.armor.com/display/KBSS/Perform+VM+Power+Actions</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:linkText> <maml:uri>https://developer.armor.com/#!/Infrastructure/Vm_PowerActionVm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |