Copy-Id
This Cmdlet will copy a records Id column to the clipboard given a QuickPick Number.
Copy
Id
This Cmdlet will copy a records Id column to the clipboard given a QuickPick Number.
qp
The QuickPick Number of the row
string
None
EXAMPLE 1
# copy-id 2
Description
-----------
This command will copy the Id of the record represented by QuickPickNumber 2
Get-Config
This Cmdlet will print out what config file entries the current session is running under.
Get
Config
This Cmdlet will print out what config file entries the current session is running under.
None
EXAMPLE 1
PS yourstorageContainer:\>
# Get-Config
Description
-----------
Prints out settings for the current session.
Map-Drive
This Cmdlet will map a Container that someone else owns to your list of available drives.
Map
Drive
This Cmdlet will map a Container that someone else owns to your list of available drives.
s
The full Container path
string
None
EXAMPLE 1
PS yourContainer:\>
# map-drive https://objects.werr.net:443/v1/9153476658759/rgtest2
Description
-----------
Maps the rgtest2 Container to the list of available drives for the user.
Remove-Drive
This Cmdlet will remove an existing mapped drive.
Map
Drive
This Cmdlet will remove an existing mapped drive.
s
The Container name
string
None
EXAMPLE 1
PS yourContainer:\>
# remove-drive rgtest
Description
-----------
removes the rgtest2 Container from the list of available drives.
Migrate-Drive
This Cmdlet is used migrate existing stores of data from external sources like S3, Dropbox and Skydrive to a target Container within OpenStack Object Storage.
Set
Config
This Cmdlet is used migrate existing stores of data from external sources like S3, Dropbox and Skydrive to a target Container within OpenStack Object Storage.
None
EXAMPLE 1
PS yourContainer:\>
# Migrate-Drive -p "S3" -sk "aa78676dhhh100" -ak "jhjhgu64332" -b "testb1", "testb2"
Description
-----------
Copies the testb1 and testb2 S3 Buckets to OpenStack Object Storage Containers of the same name. -sk = SecretKey -ak = AccessKey
EXAMPLE 2
PS yourContainer:\>
# Migrate-Drive -p "S3" -sk "aa78676dhhh100" -ak "jhjhgu64332"
Description
-----------
This example omits the Buckets (-b) parameter which forces the cmdlet to migrate all S3 Buckets to OpenStack Object Storage Containers of the same name.
EXAMPLE 3
PS yourContainer:\>
# Migrate-Drive -p "Skydrive"
Description
-----------
Migrates the local Skydrive store over to a Container called "Skydrive"
EXAMPLE 4
PS yourContainer:\>
# Migrate-Drive -p "Dropbox"
Description
-----------
Migrates the local Dropbox store over to a Container called "Dropbox"
Set-Config
This Cmdlet is used to change specific settings on a per session basis. In addition to this, all settings may be changed at once by supplying the path to a completely different config file.
Set
Config
This Cmdlet is used to change specific settings on a per session basis. In addition to this, all settings may be changed at once by supplying the path to a completely different config file.
None
EXAMPLE 1
PS yourContainer:\>
# Set-Config -k "HttpTimeOut" -v "100"
Description
-----------
Changes the HttpTimeout setting to 100 miliseconds
EXAMPLE 2
PS yourContainer:\>
# Set-Config -s "c:\testconfig.config"
Description
-----------
Replaces all current session settings with those defined within the testconfig.config file.
EXAMPLE 3
PS yourContainer:\>
# Set-Config -resercfg"
Description
-----------
Resets the current session settings to those defined within the default config file (CLI.config)
Get-Uri
This cmdlet will print out the fully qualified URI of the resource that you supply with optional parameters which constrain the URIs validity to a timepsan..
Get
URI
When you issue this command the URI is also pasted to the Windows clipboard for your convenience. If you want to disable this behavior simply set the CLI.config option entitled PasteGetURIResultsToClipboard to false.
s
The Source Path to the StorageObject.
string
dv
The number of days the URI is considered valid (optional)
string
sv
The number of seconds the URI is considered valid (optional)
string
None
EXAMPLE 1
PS yourContainer:\>
# get-uri anothertest.txt
Description
-----------
This prints out the fully qualified URI for the anothertest.txt file.
Get-Notes
This cmdlet will pull a list of release notes from the server. You can also filter the notes to a specific version.
Get
Notes
all
Prints all release notes
string
v
Prints release notes for a specific version
string
None
EXAMPLE 1
# Get-Notes -all
Description
-----------
Prints the entire set of release notes from all releases.
EXAMPLE 2
# Get-Notes -v "2.0.0.0"
Description
-----------
Prints out the release notes for the 2.0.0.0 release only.
Get-Catalog
This cmdlet will show the current Users service catalog that was retrieved when logging in. This catalog represents every service the user has authorization to use.
Get
Catalog
v
Verbose mode displays detailed information about each service that's available.
string
None
EXAMPLE 1
# Get-Catalog
Description
-----------
Shows a simple listing of available services.
EXAMPLE 2
# Get-Catalog -v
Description
-----------
Shows a more detailed list of services with additional technical information.
Get-Version
Shows the products version number.
Get
Version
None
EXAMPLE 1
# Get-Version
Description
-----------
Shows the products current version.
Remove-FloatingIP
This Cmdlet will completely remove an existing Floating IP address.
Remove
FloatingIP
This Cmdlet will completely remove an existing Floating IP address.
id
The identifier for the Floating IP address.
string
None
EXAMPLE 1
# remove-floatingIP 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will delete the floatingIP with the id of 4ee64397-1253-473c-a81d-bc23dceeef31
Remove-Network
This Cmdlet will completely remove an existing Network.
Remove
Network
This Cmdlet will completely remove an existing Network.
id
The identifier of the Network
string
None
EXAMPLE 1
# remove-network -id 12857174-99cf-40e9-999e-fb0fa2e84898
Description
-----------
This command will delete the Network with the id of 12857174-99cf-40e9-999e-fb0fa2e84898
Remove-Port
This Cmdlet will completely remove an existing Port.
Remove
Port
This Cmdlet will completely remove an existing Port.
id
The identifier of the Port
string
None
EXAMPLE 1
# remove-port -id 12857174-99cf-40e9-999e-fb0fa2e84898
Description
-----------
This command will delete the Port with the id of 12857174-99cf-40e9-999e-fb0fa2e84898
Remove-Router
This Cmdlet will completely remove an existing Router.
Remove
Port
This Cmdlet will completely remove an existing Router.
id
The identifier of the Router
string
None
EXAMPLE 1
# remove-router 12857174-99cf-40e9-999e-fb0fa2e84898
Description
-----------
This command will delete the Router with the id of 12857174-99cf-40e9-999e-fb0fa2e84898
Remove-RouterInterface
TThis Cmdlet will completely remove an existing relation between a Subnet and Router.
Remove
Port
This Cmdlet will completely remove an existing relation between a Subnet and Router.
id
The identifier of the Router
string
sid
The identifier of the Subnet.
string
None
EXAMPLE 1
# remove-routerinterface -id 12857174-99cf-40e9-999e-fb0fa2e84898 -sid bd1c30f7-71f1-455e-b91e-8d03da7f5224
Description
-----------
This command will remove the association between Router 12857174-99cf-40e9-999e-fb0fa2e84898 and Subnet bd1c30f7-71f1-455e-b91e-8d03da7f5224
Remove-Subnet
This Cmdlet will completely remove an existing Subnet.
Remove
Subnet
This Cmdlet will completely remove an existing Subnet.
id
The identifier of the Subnet
string
None
EXAMPLE 1
# remove-Subnet 12857174-99cf-40e9-999e-fb0fa2e84898
Description
-----------
This command will delete the Subnet with the id of 12857174-99cf-40e9-999e-fb0fa2e84898
New-FloatingIP
This Cmdlet will create a new FloatingIP.
New
FloatingIP
This Cmdlet will create a new FloatingIP.
pid
The identifier of the Port required to create the FloatingIP
string
nid
The identifier of the Network required to create the FloatingIP
string
None
EXAMPLE 1
# new-FloatingIP -pid 12857174-99cf-40e9-999e-fb0fa2e84898 -nid bd1c30f7-71f1-455e-b91e-8d03da7f5224
Description
-----------
This command will create a new Floating IP address for Network 12857174-99cf-40e9-999e-fb0fa2e84898 and Port bd1c30f7-71f1-455e-b91e-8d03da7f5224
New-Network
This Cmdlet will create a new Network.
New
Network
This Cmdlet will create a new Network.
n
The name of the new Network
string
asu
Determines if the AdminStateUp flag is true or false.
string
None
EXAMPLE 1
# new-network "testNet1" -asu
Description
-----------
This command will create a new network called testNet1 with its AdminStateUp set to true.
New-Port
This Cmdlet will create a new Port.
New
Port
This Cmdlet will create a new Port.
n
The name of the new Port
string
asu
Determines if the AdminStateUp flag is true or false.
string
nid
The id of the Network where the Port will exist.
string
did
The Ports DeviceId
string
None
EXAMPLE 1
# new-port "testPort1" -nid bd1c30f7-71f1-455e-b91e-8d03da7f5224 -asu -did "sdf\etc"
Description
-----------
This command will create a new Port called testNet1 on Network bd1c30f7-71f1-455e-b91e-8d03da7f5224 with its AdminStateUp set to true and a Device = sdf/etc.
New-Router
This Cmdlet will create a new Router.
New
Router
This Cmdlet will create a new Router.
n
The name of the new Router
string
asu
Determines if the AdminStateUp flag is true or false.
string
egw
The id of the External Gateway Network Id.
string
None
EXAMPLE 1
# new-router "testRouter1" -asu -egw bd1c30f7-71f1-455e-b91e-8d03da7f5224
Description
-----------
This command will create a new Router called testRouter1 on External Network bd1c30f7-71f1-455e-b91e-8d03da7f5224 with its AdminStateUp set to true.
New-RouterInterface
This Cmdlet will create a new Router.
New
RouterInterface
This Cmdlet will create a new RouterInterface.
rid
The Router Id
string
sid
The Subnet Id
string
pid
The Port Id
string
None
EXAMPLE 1
# new-routerinterface -rid bd1c30f7-71f1-455e-b91e-8d03da7f5224 -pid c9e32588-5b69-4100-a1a6-fa49094ec0a8 -sid 7yuu9886-5b69-4100-a1a6-fa49094ec0a8
Description
-----------
This command will create a new Relationship between Router (bd1c30f7-71f1-455e-b91e-8d03da7f5224), Port (c9e32588-5b69-4100-a1a6-fa49094ec0a8) and Subnet (7yuu9886-5b69-4100-a1a6-fa49094ec0a8)
New-Subnet
This Cmdlet will create a new Subnet.
New
Subnet
This Cmdlet will create a new Subnet.
nid
The id of the Network Id.
string
ipv
Sets the IP Version
string
c
The CIDR value
string
a
A comma seperated list of Allocation Pools.
string
None
EXAMPLE 1
# new-subnet -nid bd1c30f7-71f1-455e-b91e-8d03da7f5224 -ipv 4 -c "10.0.6.0/24" -a "10.0.6.20", "10.0.6.22" , "10.0.6.26", "10.0.6.29"
Description
-----------
This command will create a new Subnet.
Update-FloatingIP
This Cmdlet will update an existing FloatingIP.
Update
FloatingIP
This Cmdlet will update an existing FloatingIP.
id
The identifier of the Floating IP
string
pid
The identifier of the Port Id
string
None
EXAMPLE 1
# update-FLoatingIP -fid 12857174-99cf-40e9-999e-fb0fa2e84898 -pid c9e32588-5b69-4100-a1a6-fa49094ec0a8
Description
-----------
This command will reassign the Floating IP (12857174-99cf-40e9-999e-fb0fa2e84898) to the new Port (c9e32588-5b69-4100-a1a6-fa49094ec0a8)
Update-Network
This Cmdlet will update an existing Network.
Update
Network
This Cmdlet will update an existing Network.
id
The identifier of the Network IP
string
n
The Networks name
string
None
EXAMPLE 1
# update-Network -id 12857174-99cf-40e9-999e-fb0fa2e84898 -n "NewNameTest"
Description
-----------
This command will change the Network(12857174-99cf-40e9-999e-fb0fa2e84898) name to NewNameTest.
Update-Port
This Cmdlet will update an existing Port.
Update
Port
This Cmdlet will update an existing Port.
id
The identifier of the Port IP
string
did
The Device Id
string
None
EXAMPLE 1
# update-Port -id 12857174-99cf-40e9-999e-fb0fa2e84898 -did "984456484-76cf-431t-66f-uyt5674567543"
Description
-----------
This command will change the Port(12857174-99cf-40e9-999e-fb0fa2e84898) device to the devie with Id = 984456484-76cf-431t-66f-uyt5674567543
Update-Router
This Cmdlet will update an existing Router.
Update
Router
This Cmdlet will update an existing Router.
id
The identifier of the Router
string
nid
The identifier of the Network
string
None
EXAMPLE 1
# update-Router -id 12857174-99cf-40e9-999e-fb0fa2e84898 -nid c9e32588-5b69-4100-a1a6-fa49094ec0a8
Description
-----------
This command will reassign the Router(12857174-99cf-40e9-999e-fb0fa2e84898) to Network (c9e32588-5b69-4100-a1a6-fa49094ec0a8)
Update-Subnet
This Cmdlet will update an existing Subnet.
Update
Subnet
This Cmdlet will update an existing Subnet.
id
The identifier of the Subnet
string
egw
The identifier of the External Network Gateway
string
n
The new name of the Subnet
string
None
EXAMPLE 1
# update-Subnet -id 12857174-99cf-40e9-999e-fb0fa2e84898 -egw c9e32588-5b69-4100-a1a6-fa49094ec0a8 -n "NewSubnetName"
Description
-----------
This command will reassign the Subnet(12857174-99cf-40e9-999e-fb0fa2e84898) to External Network (c9e32588-5b69-4100-a1a6-fa49094ec0a8) with the new name of "NewSubnetName"
Get-Metadata
This Cmdlet will list out the Metadata entries assigned to the supplied resource. You can currently list metadata assigned to Servers, Storage Objects , Containers and CDN Containers.
Get
Metadata
Many resources can have zero to many custom meta-data entries assigned to them. This is essentially a list of Key Value Pairs attached to the resource that you may use for whatever you would like.
sp
The path to the remote Storage Object. Paths may be expressed as fully qualified or relative to the current location in the store.
string
cn
The Container Name.
string
cdn
The CDN Container Name.
string
sid
The Server ID.
string
None
EXAMPLE 1
PS yourContainer:\>
# Get-metadata test.txt
Description
-----------
This command will print out a list of name value pairs assigned to the. For details on how to add meta-data elements see the Set-Metadata Cmdlet.
EXAMPLE 2
# Get-metadata -sid 23465
Description
-----------
This command will print out all Metadata entries for the Server with an ID = 23465.
EXAMPLE 3
# Get-metadata -cn "Marketing"
Description
-----------
This command will print out all Metadata entries for the Marketing Container.
EXAMPLE 4
# Get-metadata -cdn "Marketing"
Description
-----------
This command will print out all Metadata entries for the Marketing CDN Container.
Set-Metadata
This Cmdlet can be used to add meta-data elements to an existing resource.
Set
Metadata
Resources can have zero to many custom meta-data entries assigned to them. This is essentially a list of Key Value Pairs attached to the object that you may use for whatever you would like.
Set-Metadata [-sp] [-sid] [-cdn] -md
sp
The path to a remote Storage Object. Paths may be expressed as fully qualified or relative to the current location in the store.
string
md
This is a comma delimited set of Name Value Pairs enclosed in quotes. the Key and Values are delimited by the pipe symbol."
string
sid
The Server Id
string
cdn
The CDN Container name.
string
None
EXAMPLE 1
PS yourContainer:\>
# Set-metadata test.txt -md "Author|Tom", "Editor|Sam"
Description
-----------
This example shows us adding two seperate KVPs to the test.txt file.
EXAMPLE 2
# Set-metadata -sid 1345 -md "Author|Tom", "Editor|Sam"
Description
-----------
This example applies the Key Value Pair (-md argument) to the Server with an Id = 1345.
EXAMPLE 3
# Set-metadata -cdn "Marketing" -md "Author|Tom", "Editor|Sam"
Description
-----------
This example applies the Key Value Pair (-md argument) to the CDN Container called Marketing.
Get-URI
This Cmdlet will show the fully qualified URI of an object in storage.
Get
Metadata
s
s
The path to the remote Storage Object. Paths may be expressed as fully qualified or relative to the current location in the store.
string
None
EXAMPLE 1
PS yourContainer:\>
# Get-URI test.xml
Description
-----------
This example shows the fully qualifed URI for the test.xml file located in the current directory.
Remove-Item
This Cmdlet remove an object in storage.
Remove
Item
s
t
The path to the remote Storage Object. Paths may be expressed as fully qualified or relative to the current location in the store.
string
None
EXAMPLE 1
PS yourContainer:\>
# Remove-Item test.xml
Description
-----------
This example the test.xml file located in the current directory.
Set-Scope
This sets a Containers scope to public.
Get
Metadata
To allow users other than the owner of a Container to access resources you need to set the Containers scope to Public with this cmdlet.
SourcePath
Name
The Containers name.
string
None
EXAMPLE 1
PS yourContainer:\>
#set-scope testContainer -s public
Description
-----------
This example shows us changing the testContainers scope to public.
Remove-Container
Removes the specified Container from the system optionally forcing the operation to complete without confirmation.
Remove
Container
Name
The name of the Container to remove.
string
ForceDelete
This switch forces the Container to be removed without any confirmation prompt.
string
cdn
Removes any associated CDN entry when the Container is removed.
string
None
EXAMPLE 1
PS yourContainer:\>
# remove-container testContainer
Description
-----------
Removes testContainer from the system but prompts the user for confirmation before continuing.
EXAMPLE 2
PS yourContainer:\>
# remove-container testContainer -fd
Description
-----------
Forces the system to delete the specified Container without confirmation from the user.
New-Container
This Cmdlet create a new storage Container.
New
Container
You must be a registered user of the OpenStack Cloud Services platform in order to perform this operation because it requires a valid access key id to authenticate the request. Therefore anonymous requests can not create Containers. When you create a Container, you become the Container owner.
Name
Name
The name of the Container to create.
string
Url
The url to a Shared Container.
string
None
EXAMPLE 1
PS yourContainer:\>
# New-Container marketing
Description
-----------
This command will create a new Container named marketing.
EXAMPLE 2
PS yourContainer:\>
# New-Container https://region-a.geo-1.objects.Openstacksvc.com/v1/AUTH_2485a207-71a4-4429-9e24-f7bf49e207fc/testcon
Description
-----------
This command will allow use of the Shared Container named testcon.
New-Volume
This Cmdlet creates a new Block Storage Volume.
New
Volume
New-Volume
svid
The Source Volume Id to derive this volume from. The Source Volume Id must reside in the same AZ as the one you are creating.
string
az
The target Availability Zone to create the Volume in.
string
Name
The name of the Volume to create.
string
Description
A quick description of the Volumes purpose.
string
Size
The size (in Gb) of the Volume.
string
Metadata
Additional Metadata associated with the Volume. This will be a comma delimited set of name value pairs which are themselves pipe delimited.
string
None
EXAMPLE 1
# New-Volume "TestVolume" "This is a simple Volume test" 20
Description
-----------
This command will create a new 20 gig Volume.
EXAMPLE 2
# New-Volume "TestVolume" "This is a simple Volume test" 20 "test|data", "another|test"
Description
-----------
This command will create a new 20 gig Volume with additional metadata
Remove-Volume
This Cmdlet deletes an existing Block Storage Volume.
Remove
Volume
Remove-Volume
VolumeId
The Volumes unique identifier.
string
None
EXAMPLE 1
# Remove-Volume 12857174-99cf-40e9-999e-fb0fa2e84898
Description
-----------
This command will remove a existing Volume with an Id = 12857174-99cf-40e9-999e-fb0fa2e84898.
Attach-Volume
This Cmdlet associates a Volume with an existing Server.
Attach
Volume
Attach-Volume
id
The id of the target Server.
string
VolumeId
The Volumes unique identifier.
string
Device
The associations Device name.
string
None
EXAMPLE 1
# Attach-Volume -s 12857174-99cf-40e9-999e-fb0fa2e84898 -v 7da74520-9d5e-427b-a508-213c84e69616 "/dev/vdp"
Description
-----------
This command will associate Volume 7da74520-9d5e-427b-a508-213c84e69616 to Server 12857174-99cf-40e9-999e-fb0fa2e84898 with an assigned device name of /dev/vdX.
Detach-Volume
This Cmdlet disassociates a Volume with an existing Server.
Detach
Volume
Detach-Volume
Id
The id of the target Server.
string
VolumeId
The Volumes unique identifier.
string
None
EXAMPLE 1
# Detach-Volume -v 7da74520-9d5e-427b-a508-213c84e69616 -s 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will disassociate Volume a508 from Server 4ee64397-1253-473c-a81d-bc23dceeef31.
New-Snapshot
This Cmdlet creates a new Block Storage Snapshot.
New
Snapshot
New-Snapshot
Name
The name of the Snapshot to create.
string
Description
A quick description of the Snapshots contents.
string
VolumeId
The Id of the Volume that we're taking the snapshot of.
string
Force
Force
string
None
EXAMPLE 1
# New-Snapshot -n "TestSnapshot" -d "This is a simple Snapshot test" -v 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will create a new snapshot of Volume 4ee64397-1253-473c-a81d-bc23dceeef31
Remove-Snapshot
This Cmdlet deletes an existing Block Storage Snapshot.
Remove
Snapshot
Remove-Snapshot
SnapshotId
The Snapshots unique identifier.
string
None
EXAMPLE 1
# Remove-Snapshot -s 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will remove a existing Snapshot with an Id = 4ee64397-1253-473c-a81d-bc23dceeef31.
New-Keypair
This Cmdlet creates a new keypair for the user.
New
Keypair
New-Keypair
Name
The name of the Keypair to create.
string
None
EXAMPLE 1
# New-Keypair "TestKey"
Description
-----------
This command will create a new Keypair named TestKey.
Remove-Keypair
This Cmdlet deletes a previously created keypair for the user.
Remove
Keypair
Remove-Keypair
Name
The name of the Keypair to delete.
string
None
EXAMPLE 1
# Remove-Keypair "TestKey"
Description
-----------
This command will delete an existing Keypair named TestKey.
Disassociate-IP
This Cmdlet releases a previously allocated IP address.
Disassociate
IP
Disassociate-IP
ip
The IP address to release.
string
None
EXAMPLE 1
# Disassociate-IP 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will release a previously allocated IP address.
UnAssign-IP
This Cmdlet assigns an existing IP address to an existing Server.
UnAssign
IP
UnAssign-IP
ip
The IP address to disassociate.
string
sid
The Server Id that will be disassociated from the supplied IP address.
string
None
EXAMPLE 1
#Unassign-IP "192.168.110.45" -s 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will remove the supplied IP address from server 4ee64397-1253-473c-a81d-bc23dceeef31
Assign-IP
This Cmdlet assigns an existing IP address to an existing Server.
Assign
IP
Assign-IP
ip
The IP address to assign.
string
sid
The Server Id that will be assigned to.
string
None
EXAMPLE 1
#Assign-IP "192.168.110.45" -s 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will assign the supplied IP address to server 4ee64397-1253-473c-a81d-bc23dceeef31
New-CDN
This Cmdlet will create a new CDN entry for the specified Container.
New
CDN
New-CDN
None
EXAMPLE 1
# New-CDN -n "TestContainer"
Description
-----------
Associates a new CDN entry for the existing Container called TestContainer.
Remove-CDN
This Cmdlet will remove a CDN entry for the specified Container.
Remove
CDN
Remove-CDN
None
EXAMPLE 1
# Remove-CDN -n "TestContainer"
Description
-----------
Disassociates the CDN entry for existing container TestContainer.
List-CDN
This Cmdlet will list out all Containers that have associated CDN entries.
List
CDN
List-CDN
None
EXAMPLE 1
# List-CDN
Description
-----------
This cmdlet will list out all Containers with associated CDN entries.
Set-Zone
This Cmdlet will force subsequent cmdlets to utilize the Availability Zone supplied.
Set
Zone
Set-Zone
z
The Availability ZoneID to be set.
string
None
EXAMPLE 1
# Set-Zone 1
Description
-----------
This command will cause all susequent Compute related IO to be directed to the AZ-2 Zone which has the Id of 1. The Id's for each Zone can be found by issueing the Get-Zones cmdlet.
Set-ZoneColor
This command will set all output to a specific color when the User selects the Zone via Set-Zone.
Set
ZoneColor
Set-ZoneColor
z
The Availability ZoneID to be set.
string
c
The color for the zones output. Valid values are "Black", "Blue", "Cyan", "DarkBlue", "DarkCyan", "DarkGray", "DarkGreen", "DarkMagenta", "DarkRed", "DarkYellow", "Gray", "Green", "Magenta", "Red", "White", and "Yellow".
string
None
EXAMPLE 1
# Set-ZoneColor -z 1 -c Green
Description
-----------
This command will set all output to Green when the User selects the Zone via Set-Zone.
Get-Zone
This Cmdlet will current Availability Zone being used.
Get
Zone
Get-Zone
None
EXAMPLE 1
# Get-Zone
Description
-----------
This command will simply show the current Availability Zone in use.
Associate-IP
This Cmdlet will request a new Floating IP address from the server.
Associate
IP
Associate-IP
None
EXAMPLE 1
# Associate-IP
Description
-----------
Request a new Floating IP address from the server.
Add-Rule
This Cmdlet creates a new Security Group Rule and assigns it to an existing Security Group
Add
Rule
Add-Rule
d
Ingress or egress: The direction in which the security group rule is applied. For a compute instance, an ‘ingress’ security group rule matches traffic that is incoming (ingress) for that instance. An ‘egress’ rule is applied to traffic leaving the instance.
string
max
The maximum port number in the range that is matched by the security group rule. The port_range_min attribute constrains the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.
string
min
The minimum port number in the range that is matched by the security group rule. If the protocol is TCP or UDP, this value must be less than or equal to the value of the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.
string
p
The protocol that is matched by the security group rule. Valid values are null, tcp, udp, and icmp.
string
rgid
The remote group ID to be associated with this security group rule.
string
ripp
The remote IP prefix to be associated with this security group rule.
string
sgid
The Security GroupId used to apply this rule.
string
None
EXAMPLE 1
# Add-Rule -min "80" -max "85" -d "ingress" -et -p icmp IPv4 -sgid 2076db17-a522-4506-91de-c6dd8e837028
Description
-----------
This will create a new Security Group Rule affecting the tcp protocol from port 80 to 85 and assign it to SecurityGroup 2076db17-a522-4506-91de-c6dd8e837028.
Remove-Rule
This Cmdlet will delete an existing Security Group Rule.
Remove
Rule
Remove-Rule
id
The Security GroupRuleId used to remove the rule.
string
None
EXAMPLE 1
# Remove-Rule -id 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
Remove the SecurityGroupRule with an Id of 4ee64397-1253-473c-a81d-bc23dceeef31.
New-SecurityGroup
This Cmdlet creates a new Security Group.
New
SecurityGroup
New-SecurityGroup
n
The name of the new Security Group.
string
d
A brief description of the groups purpose.
string
None
EXAMPLE 1
# New-SecurityGroup -n "TestGroup" -d "SomeDescription"
Description
-----------
This command will create a simple test Security Group.
Remove-SecurityGroup
This Cmdlet will delete an existing Security Group.
Remove
SecurityGroup
Remove-SecurityGroup
id
The identifier used to remove the Security Group.
string
None
EXAMPLE 1
# Remove-SecurityGroup -id 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
Remove the Security Group with an Id of 4ee64397-1253-473c-a81d-bc23dceeef31.
Add-Metadata
This Cmdlet associates a set of key value pairs with a Server.
Add
Metadata
Add-Metadata
md
A pipe delimited set of Name Value Pairs seperated by commas. "Namevalue1 | value1" , "NameValue2 | value2", "NameValue3 | value3" etc..
string
s
The identifier (ServerId) used to associate this metadata with. If your currently viewing a Servers details this parameter may be ommited as it's supplied for you.
string
None
EXAMPLE 1
# Add-Metadata -md "Namevalue1 | value1" , "NameValue2 | value2", "NameValue3 | value3" -s 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will add threee Name Value Pairs to Server 4ee64397-1253-473c-a81d-bc23dceeef31.
New-Server
This Cmdlet creates a new Server.
New
Server
New-Server
nid
A Comma seperated list of targeted network Ids.
string
az
Ther Servers Availability Zone
string
n
The Servers name.
string
i
The identifier (ImageRefId) used to define this Server.
string
k
The name of a keypair to assign to the newly created Server.
string
sg
A comma delimited set of quoted SecurityGroup names that are to be applied to the newly created Server.
string
f
The identifier (FlavorRefId) used to define this Server.
string
p
A password may be specified when creating the server via this optional parameter. If a password is not specified, a randomly generated password will be assigned and returned in the response.
string
ip4
ip4 based access address.
string
ip6
ip6 based access address.
string
md
A pipe delimited set of Name Value Pairs seperated by commas. "Namevalue1 | value1" , "NameValue2 | value2", "NameValue3 | value3" etc..
string
None
EXAMPLE 1
# New-Server -n "TestServer" -p "gooblygook" -i "2111" -f "100" -md "Namevalue1 | value1" , "NameValue2 | value2", "NameValue3 | value3" -s 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
This command will create a new server with some metadata.
EXAMPLE 2
# New-Server -n "TestServer" -p "gooblygook" -i "2111" -f "100" -s "2133" -k "testkey"
Description
-----------
This command will create a new server using the testkey keypair name.
Reboot-Server
This cmdlet allows for either a soft or hard reboot of a server. With a soft reboot, the operating system is signaled to restart, which allows for a graceful shutdown of all processes. A hard reboot is the equivalent of power cycling the server.
Reboot
Server
Reboot-Server
id
The Servers identifier.
string
t
With a soft reboot (SOFT), the operating system is signaled to restart, which allows for a graceful shutdown of all processes. A hard reboot (HARD) is the equivalent of power cycling the server.
EXAMPLE 1
# Reboot-Server -s 4ee64397-1253-473c-a81d-bc23dceeef31 -t "SOFT"
Description
-----------
Perform a soft reboot on the specified server
Remove-Server
This cmdlet deletes an existing Server.
Remove
Server
Remove-Server
id
The Servers identifier.
string
t
Deletes an existing Server.
EXAMPLE 1
# Remove-Server -s 4ee64397-1253-473c-a81d-bc23dceeef31
Description
-----------
Deletes the server with the identifier 4ee64397-1253-473c-a81d-bc23dceeef31.
Reset-Password
This cmdlet resets the administrators password for the given Server.
Reset
Password
Reset-Password
id
The Servers identifier.
string
p
The password which must meet the complexity requirements set by your OpenStack Compute provider.
EXAMPLE 1
# Reset-Password -id 4ee64397-1253-473c-a81d-bc23dceeef31 -p "testpassword08"
Description
-----------
Resets the Admin password on Server 4ee64397-1253-473c-a81d-bc23dceeef31.
Update-Server
This cmdlet allows you to change the Servers name property.
Update
Server
Update-Server
id
The Servers identifier.
string
n
The new Server name.
EXAMPLE 1
# Update-Server -id 4ee64397-1253-473c-a81d-bc23dceeef31 -n "NewName"
Description
-----------
Updates Server 4ee64397-1253-473c-a81d-bc23dceeef31 to the new name of NewName.
New-Image
This Cmdlet crfeates a new Image based on an existing Server.
New
Image
New-Image
md
A pipe delimited set of Name Value Pairs seperated by commas. "Namevalue1 | value1" , "NameValue2 | value2", "NameValue3 | value3" etc..
string
s
The identifier (ServerId) to base the Image on.
string
n
The name of the new Image.
string
None
EXAMPLE 1
# New-Image -md "Namevalue1 | value1" , "NameValue2 | value2", "NameValue3 | value3" -s 4ee64397-1253-473c-a81d-bc23dceeef31 -n "TestImage"
Description
-----------
This command will add three Name Value Pairs to the image for Server 4ee64397-1253-473c-a81d-bc23dceeef31.