Supported Commands Functions

Mitch Robins edited this page Oct 7, 2013 · 24 revisions
Clone this wiki locally

The following commands have been coded and tested against a live Rackspace cloud account, and are therefore supported. If you run into issues with any of the commands, please fill out an issue form and I will jump on it as soon as I can for you. If you need help with a command, always remember that you can run "Get-Help Command-Here -Full" for specific examples and parameter breakdown of each cmdlet. That help command will be your best friend if you are somewhat new to Powershell.

Any commands you see in the code that are not published on this page (this should rarely be the case), are commands that are being finalized for widespread use without issue. If you have questions about any you come across, please shoot me an email and I'll let you know my thoughts. Otherwise, if you choose to try one, please remember that it's not a finished product yet, and as usual, running commands at your own risk.

Remember Get-Help CmdletName-GoesHere in Powershell is your best friend.

Authentication Cmdlets

  • Get-AuthToken

This cmdlet checks if you have a current authentication token for executing an API request. If no authentication token is found or if it is out of date, it will execute Pop-AuthToken.

  • Pop-AuthToken

This cmdlet sends a request to the authentication service to retrieve an authorization token for future API requests. Tokens are good for 24 hours.

Rackspace Cloud Server Cmdlets

  • Get-CloudServers

This cmdlet gets a list of cloud servers associated with your username and API key.

  • Get-CloudServerDetails

This cmdlet will retrieve a list of more specific attributes specifically for a provided cloud server ID.

  • Get-CloudServerImages

This cmdlet will retrieve a list of all Rackspace provided and custom created server images and their related IDs.

  • Get-CloudServerFlavors

This cmdlet will retrieve a list of all Rackspace offered flavor templates and their related IDs.

  • Add-CloudServer

This cmdlet will send an API request to spin up a new cloud server of your choosing and return it's root/admin username and password.

  • Add-CloudServerImage

This cmdlet will create an image snapshot of a cloud server.

  • Update-CloudServer

This cmdlet will allow you to update any of the following cloud server parameters: server name, IPv4/v6 address, admin password change.

  • Restart-CloudServer

This cmdlet will allow you to SOFT or HARD restart a cloud server.

  • Resize-CloudServer

This cmdlet will allow you to resize a cloud server up/down based on a flavor ID. You can also CONFIRM and REVERT changes via this command.

  • Remove-CloudServer

This cmdlet will allow you to permanently delete a cloud server.

  • Remove-CloudServerImage

This cmdlet will allow you to permanently delete a cloud server image snapshot.

  • Set-CloudServerRescueMode

This cmdlet will place your cloud server into rescue mode for recovering from critical errors (Linux Only). This mode is only valid for 90 minutes at a time.

  • Remove-CloudServerRescueMode

This cmdlet will remove a cloud server from rescue mode and restore it to normal operation, if possible.

Rackspace Cloud Block Storage (CBS) Cmdlets

  • Get-CloudBlockStorageVolList

This cmdlet will allow you to retrieve a list of CBS volumes.

  • Get-CloudBlockStorageVol

This cmdlet will allow you to retrieve a list of all attributes related to the specified CBS volume.

  • Get-CloudBlockStorageTypes

This cmdlet will allow you to retrieve a list of CBS volume types.

  • Get-CloudBlockStorageSnapList

This cmdlet will allow you to retrieve a list of CBS volume snapshots.

  • Get-CloudBlockStorageSnap

This cmdlet will allow you to retrieve a list of all attributes for the specified CBS volume snapshot.

  • Remove-CloudBlockStorageSnap

This cmdlet will allow you to remove a CBS volume snapshot from your account.

  • Remove-CloudBlockStorageVol

This cmdlet will allow you to remove a CBS volume from your account.

  • Add-CloudBlockStorageSnap

This cmdlet will allow you to create a new CBS volume snapshot.

  • Add-CloudBlockStorageVol

This cmdlet will allow you to create a new CBS volume.

Rackspace Cloud Networks Cmdlets

  • Get-CloudNetworks

This cmdlet will allow you to retrieve a list of provisioned Rackspace cloud networks.

  • Add-CloudNetwork

This cmdlet will allow you to create a new cloud network for your servers.

  • Remove-CloudNetwork

This cmdlet will allow you to delete a cloud network.

Rackspace Cloud Load Balancer (CLB) Cmdlets

  • Get-CloudLoadBalancers

This cmdlet will allow you to retrieve a list of provisioned Rackspace cloud load balancers.

  • Get-CloudLoadBalancerDetails

This cmdlet will allow you to specify a Rackspace cloud load balancer ID and retrieve detailed information about that CLB and its child nodes.

  • Get-CloudLoadBalancerNodeList

This cmdlet will allow you to query a provisioned load balancer to see information about the nodes that are running behind it.

  • Get-CloudLoadBalancerProtocols

This cmdlet will allow you to query for all available load balancer protocols you can use when adding/modifying a load balancer.

  • Get-CloudLoadBalancerAlgorithms

This cmdlet will allow you to query for all available load balancer algorithms you can use when adding/modifying a load balancer.

  • Add-CloudLoadBalancer

This cmdlet will add a CLB with the minimal required data: name, port, protocol, region, node ip, node port.

  • Remove-CloudLoadBalancer

This cmdlet will remove a CLB from your account.

  • Add-CloudLoadBalancerNode

This cmdlet will add a node to the specified CLB.

  • Remove-CloudLoadBalancerNode

This cmdlet will remove a node from the specified CLB.

  • Update-CloudLoadBalancerNode

This cmdlet will update the configuration of a node assigned to the specified CLB.

  • Update-CloudLoadBalancer

This cmdlet will update the configuration of the specified load balancer.

  • Get-CloudLoadBalancerNodeEvents

This cmdlet will retrieve a list of logged events for the specified node.

  • Get-CloudLoadBalancerACLs

This cmdlet will allow you to retrieve a list of all configured ACL items of a load balancer.

  • Add-CloudLoadBalancerACLItem

This cmdlet will allow you to add/append an ACL item.

  • Remove-CloudLoadBalancerACLItem

This cmdlet will allow you to remove a specific ACL item.

  • Remove-CloudLoadBalancerACL

This cmdlet will allow you to permanently delete ALL items from the load balancer's ACL.

  • Add-SessionPersistence

This cmdlet will allow you to configure session persistence of a specified load balancer.

  • Update-SessionPersistence

This cmdlet will allow you to update the session persistence configuration of a specified load balancer.

  • Remove-SessionPersistence

This cmdlet will allow you to remove the session persistence configuration of a specified load balancer.

  • Add-ConnectionLogging

This cmdlet will allow you to configure connection logging for a specified load balancer.

  • Remove-ConnectionLogging

This cmdlet will allow you to remove all connection logging from a specified load balancer.

  • Add-ConnectionThrottling

This cmdlet will allow you to configure connection throttling for a specified load balancer.

  • Update-ConnectionThrottling

This cmdlet will allow you to update the connection throttling configuration of a specified load balancer.

  • Remove-ConnectionThrottling

This cmdlet will allow you to remove all connection throttling from a specified load balancer.

  • Get-HealthMonitor

This cmdlet will allow you to retrieve the status and config of a health monitor assigned to a load balancer.

  • Add-HealthMonitor

This cmdlet will allow you to add/update a health monitor assigned to a cloud load balancer.

  • Remove-HealthMonitor

This cmdlet will allow you to remove a health monitor assigned to a cloud load balancer.

  • Add-ContentCaching

This cmdlet will allow you to enable content caching on a cloud load balancer.

  • Remove-ContentCaching

This cmdlet will allow you to disable content caching on a cloud load balancer.

  • Get-SSLTermination

This cmdlet will allow you to retrieve your SSL termination configuration settings.

  • Add-SSLTermination

This cmdlet will allow you to enable and configure SSL termination on your load balancer.

  • Update-SSLTermination

This cmdlet will allow you to update a specific load balancer's SSL termination settings.

  • Remove-SSLTermination

This cmdlet will allow you to permanently delete all SSL termination settings from a load balancer.

Rackspace Cloud Files

  • Get-CloudFilesStatistics

This cmdlet will return the number of objects, the size of the objects in bytes, and the number of containers in the requested Rackspace Cloud Files region.