# -*- coding: utf-8 -*-

# Auto-generated code by cachemaker.py

# Licensed to the Apache Software Foundation (ASF) under one

# or more contributor license agreements. See the NOTICE file

# distributed with this work for additional information

# regarding copyright ownership. The ASF licenses this file

# to you under the Apache License, Version 2.0 (the

# "License"); you may not use this file except in compliance

# with the License. You may obtain a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing,

# software distributed under the License is distributed on an

# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

# KIND, either express or implied. See the License for the

# specific language governing permissions and limitations

# under the License.

apicache = {u'authorize': {u'securitygroupingress': {u'name': u'authorizeSecurityGroupIngress', u'related': [u'authorizeSecurityGroupEgress'], u'isasync': True, u'params': [{u'name': u'protocol', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'TCP is default. UDP is the other supported protocol'}, {u'name': u'securitygroupid', u'required': False, u'related': [u'createSecurityGroup', u'listSecurityGroups'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the security group. Mutually exclusive with securityGroupName parameter'}, {u'name': u'startport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'start port for this ingress rule'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the security group. Must be used with domainId.'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list associated'}, {u'name': u'securitygroupname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The name of the security group. Mutually exclusive with securityGroupName parameter'}, {u'name': u'endport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'end port for this ingress rule'}, {u'name': u'usersecuritygrouplist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'user to security group mapping'}, {u'name': u'icmptype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'type of the icmp message being sent'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'an optional project of the security group'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the security group. If the account parameter is used, domainId must also be used.'}, {u'name': u'icmpcode', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'error code for this icmp message'}], u'requiredparams': [], u'description': u'Authorizes a particular ingress rule for this security group'}, u'securitygroupegress': {u'name': u'authorizeSecurityGroupEgress', u'related': [], u'isasync': True, u'params': [{u'name': u'protocol', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'TCP is default. UDP is the other supported protocol'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'an optional project of the security group'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the security group. If the account parameter is used, domainId must also be used.'}, {u'name': u'usersecuritygrouplist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'user to security group mapping'}, {u'name': u'endport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'end port for this egress rule'}, {u'name': u'icmpcode', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'error code for this icmp message'}, {u'name': u'startport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'start port for this egress rule'}, {u'name': u'securitygroupname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The name of the security group. Mutually exclusive with securityGroupName parameter'}, {u'name': u'icmptype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'type of the icmp message being sent'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list associated'}, {u'name': u'securitygroupid', u'required': False, u'related': [u'listSecurityGroups'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the security group. Mutually exclusive with securityGroupName parameter'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the security group. Must be used with domainId.'}], u'requiredparams': [], u'description': u'Authorizes a particular egress rule for this security group'}}, u'restore': {u'virtualmachine': {u'name': u'restoreVirtualMachine', u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'isasync': True, u'params': [{u'name': u'templateid', u'required': False, u'related': [u'listIsos', u'updateIso', u'copyIso'], u'length': 255, u'type': u'uuid', u'description': u'an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'restoreVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'Virtual Machine ID'}], u'requiredparams': [u'virtualmachineid'], u'description': u'Restore a VM to original template/ISO or new template/ISO'}}, u'suspend': {u'project': {u'name': u'suspendProject', u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject', u'suspendProject'], u'length': 255, u'type': u'uuid', u'description': u'id of the project to be suspended'}], u'requiredparams': [u'id'], u'description': u'Suspends a project'}}, u'revoke': {u'securitygroupingress': {u'name': u'revokeSecurityGroupIngress', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The ID of the ingress rule'}], u'requiredparams': [u'id'], u'description': u'Deletes a particular ingress rule from this security group'}, u'securitygroupegress': {u'name': u'revokeSecurityGroupEgress', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'authorizeSecurityGroupEgress'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the egress rule'}], u'requiredparams': [u'id'], u'description': u'Deletes a particular egress rule from this security group'}}, u'disassociate': {u'ipaddress': {u'name': u'disassociateIpAddress', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'associateIpAddress'], u'length': 255, u'type': u'uuid', u'description': u'the id of the public ip address to disassociate'}], u'requiredparams': [u'id'], u'description': u'Disassociates an ip address from the account.'}}, u'migrate': {u'volume': {u'name': u'migrateVolume', u'related': [u'detachVolume', u'createVolume', u'updateVolume', u'attachVolume', u'resizeVolume', u'uploadVolume'], u'isasync': True, u'params': [{u'name': u'volumeid', u'required': True, u'related': [u'detachVolume', u'createVolume', u'migrateVolume', u'updateVolume', u'attachVolume', u'resizeVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the volume'}, {u'name': u'storageid', u'required': True, u'related': [u'updateStoragePool', u'findStoragePoolsForMigration', u'cancelStorageMaintenance', u'createStoragePool', u'listStoragePools', u'enableStorageMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'destination storage pool ID to migrate the volume to'}, {u'name': u'livemigrate', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if the volume should be live migrated when it is attached to a running vm'}], u'requiredparams': [u'volumeid', u'storageid'], u'description': u'Migrate volume'}, u'systemvm': {u'name': u'migrateSystemVm', u'related': [u'scaleSystemVm', u'listSystemVms', u'rebootSystemVm'], u'isasync': True, u'params': [{u'name': u'virtualmachineid', u'required': True, u'related': [u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'rebootSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine'}, {u'name': u'hostid', u'required': True, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'destination Host ID to migrate VM to'}], u'requiredparams': [u'virtualmachineid', u'hostid'], u'description': u'Attempts Migration of a system virtual machine to the host specified.'}, u'virtualmachine': {u'name': u'migrateVirtualMachine', u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'isasync': True, u'params': [{u'name': u'storageid', u'required': False, u'related': [u'findStoragePoolsForMigration'], u'length': 255, u'type': u'uuid', u'description': u'Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine'}, {u'name': u'hostid', u'required': False, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'Destination Host ID to migrate VM to. Required for live migrating a VM from host to host'}], u'requiredparams': [u'virtualmachineid'], u'description': u'Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool'}, u'virtualmachinewithvolume': {u'name': u'migrateVirtualMachineWithVolume', u'related': [u'revertToVMSnapshot', u'stopVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'isasync': True, u'params': [{u'name': u'migrateto', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'Map of pool to which each volume should be migrated (volume/pool pair)'}, {u'name': u'hostid', u'required': True, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'Destination Host ID to migrate VM to.'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine'}], u'requiredparams': [u'hostid', u'virtualmachineid'], u'description': u'Attempts Migration of a VM with its volumes to a different host'}}, u'lock': {u'account': {u'name': u'lockAccount', u'related': [u'listAccounts', u'disableAccount', u'createAccount', u'markDefaultZoneForAccount'], u'isasync': False, u'params': [{u'name': u'account', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Locks the specified account.'}, {u'name': u'domainid', u'required': True, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'Locks the specified account on this domain.'}], u'requiredparams': [u'account', u'domainid'], u'description': u'Locks an account'}, u'user': {u'name': u'lockUser', u'related': [u'listUsers'], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listUsers', u'lockUser'], u'length': 255, u'type': u'uuid', u'description': u'Locks user by user ID.'}], u'requiredparams': [u'id'], u'description': u'Locks a user account'}}, u'copy': {u'iso': {u'name': u'copyIso', u'related': [u'listIsos', u'updateIso'], u'isasync': True, u'params': [{u'name': u'sourcezoneid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'ID of the zone the template is currently hosted on.'}, {u'name': u'id', u'required': True, u'related': [u'listIsos', u'updateIso', u'copyIso'], u'length': 255, u'type': u'uuid', u'description': u'Template ID.'}, {u'name': u'destzoneid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'ID of the zone the template is being copied to.'}], u'requiredparams': [u'sourcezoneid', u'id', u'destzoneid'], u'description': u'Copies an iso from one zone to another.'}, u'template': {u'name': u'copyTemplate', u'related': [u'updateTemplate', u'registerTemplate', u'createTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'isasync': True, u'params': [{u'name': u'destzoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'ID of the zone the template is being copied to.'}, {u'name': u'sourcezoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'ID of the zone the template is currently hosted on.'}, {u'name': u'id', u'required': True, u'related': [u'updateTemplate', u'registerTemplate', u'createTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'copyTemplate', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'Template ID.'}], u'requiredparams': [u'destzoneid', u'sourcezoneid', u'id'], u'description': u'Copies a template from one zone to another.'}}, u'replace': {u'networkacllist': {u'name': u'replaceNetworkACLList', u'related': [], u'isasync': True, u'params': [{u'name': u'gatewayid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the private gateway'}, {u'name': u'networkid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network'}, {u'name': u'aclid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network ACL'}], u'requiredparams': [u'aclid'], u'description': u'Replaces ACL associated with a Network or private gateway'}}, u'list': {u'lbhealthcheckpolicies': {u'name': u'listLBHealthCheckPolicies', u'related': [u'createLBHealthCheckPolicy'], u'isasync': False, u'params': [{u'name': u'lbruleid', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [u'lbruleid'], u'description': u'Lists load balancer HealthCheck policies.'}, u'instancegroups': {u'name': u'listInstanceGroups', u'related': [u'updateInstanceGroup', u'createInstanceGroup'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list instance groups by name'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'id', u'required': False, u'related': [u'updateInstanceGroup', u'createInstanceGroup', u'listInstanceGroups'], u'length': 255, u'type': u'uuid', u'description': u'list instance groups by ID'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists vm groups'}, u'ucsmanagers': {u'name': u'listUcsManagers', u'related': [u'addUcsManager'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the zone id'}, {u'name': u'id', u'required': False, u'related': [u'listUcsManagers', u'addUcsManager'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the ucs manager'}], u'requiredparams': [], u'description': u'List ucs manager'}, u'physicalnetworks': {u'name': u'listPhysicalNetworks', u'related': [], u'isasync': False, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'search by name'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the physical network'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'list physical network by id'}], u'requiredparams': [], u'description': u'Lists physical networks'}, u'vmsnapshot': {u'name': u'listVMSnapshot', u'related': [], u'isasync': False, u'params': [{u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists snapshot by snapshot name or display name'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'state of the virtual machine snapshot'}, {u'name': u'vmsnapshotid', u'required': False, u'related': [u'listVMSnapshot'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the VM snapshot'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the vm'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'List virtual machine snapshot by conditions'}, u'networkofferings': {u'name': u'listNetworkOfferings', u'related': [u'updateNetworkOffering', u'createNetworkOffering'], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network offerings by display text'}, {u'name': u'guestiptype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network offerings by guest type: Shared or Isolated'}, {u'name': u'specifyipranges', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if need to list only network offerings which support specifying ip ranges'}, {u'name': u'id', u'required': False, u'related': [u'listNetworkOfferings', u'updateNetworkOffering', u'createNetworkOffering'], u'length': 255, u'type': u'uuid', u'description': u'list network offerings by id'}, {u'name': u'forvpc', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'the network offering can be used only for network creation inside the VPC'}, {u'name': u'supportedservices', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list network offerings supporting certain services'}, {u'name': u'networkid', u'required': False, u'related': [u'createNetwork', u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network offerings by state'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'list network offerings by tags'}, {u'name': u'traffictype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by traffic type'}, {u'name': u'specifyvlan', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'the tags for the network offering.'}, {u'name': u'isdefault', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if need to list only default network offerings. Default value is false'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'list netowrk offerings available for network creation in specific zone'}, {u'name': u'availability', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the availability of network offering. Default value is Required'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network offerings by name'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'sourcenatsupported', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if need to list only netwok offerings where source nat is supported, false otherwise'}, {u'name': u'istagged', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if offering has tags specified'}], u'requiredparams': [], u'description': u'Lists all available network offerings.'}, u'traffictypes': {u'name': u'listTrafficTypes', u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'physicalnetworkid', u'required': True, u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [u'physicalnetworkid'], u'description': u'Lists traffic types of a given physical network.'}, u'clusters': {u'name': u'listClusters', u'related': [u'updateCluster'], u'isasync': False, u'params': [{u'name': u'clustertype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists clusters by cluster type'}, {u'name': u'managedstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'whether this cluster is managed by cloudstack'}, {u'name': u'id', u'required': False, u'related': [u'listClusters', u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'lists clusters by the cluster ID'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists clusters by allocation state'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'lists clusters by Zone ID'}, {u'name': u'podid', u'required': False, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'lists clusters by Pod ID'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists clusters by the cluster name'}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists clusters by hypervisor type'}, {u'name': u'showcapacities', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'flag to display the capacity of the clusters'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists clusters.'}, u'resourcelimits': {u'name': u'listResourceLimits', u'related': [], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'resourcetype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Type of resource to update. Values are 0, 1, 2, 3, and 4.0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own.3 - Snapshot. Number of snapshots an account can own.4 - Template. Number of templates an account can register/create.5 - Project. Number of projects an account can own.6 - Network. Number of networks an account can own.7 - VPC. Number of VPC an account can own.8 - CPU. Number of CPU an account can allocate for his resources.9 - Memory. Amount of RAM an account can allocate for his resources.10 - Primary Storage. Amount of Primary storage an account can allocate for his resoruces.11 - Secondary Storage. Amount of Secondary storage an account can allocate for his resources.'}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'Lists resource limits by ID.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [], u'description': u'Lists resource limits.'}, u'firewallrules': {u'name': u'listFirewallRules', u'related': [u'createFirewallRule', u'listEgressFirewallRules'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'Lists rule with the specified ID.'}, {u'name': u'ipaddressid', u'required': False, u'related': [u'associateIpAddress'], u'length': 255, u'type': u'uuid', u'description': u'the id of IP address of the firwall services'}], u'requiredparams': [], u'description': u'Lists all firewall rules for an IP address.'}, u'supportednetworkservices': {u'name': u'listSupportedNetworkServices', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'service', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'network service name to list providers and capabilities of'}, {u'name': u'provider', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'network service provider name'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all network services provided by CloudStack or for the given Provider.'}, u'loadbalancerrules': {u'name': u'listLoadBalancerRules', u'related': [u'createLoadBalancerRule'], u'isasync': False, u'params': [{u'name': u'publicipid', u'required': False, u'related': [u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the public IP address id of the load balancer rule '}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the availability zone ID'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine of the load balancer rule'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'id', u'required': False, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'list by network id the rule belongs to'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the load balancer rule'}], u'requiredparams': [], u'description': u'Lists load balancer rules.'}, u'autoscalepolicies': {u'name': u'listAutoScalePolicies', u'related': [u'updateAutoScalePolicy', u'createAutoScalePolicy'], u'isasync': False, u'params': [{u'name': u'vmgroupid', u'required': False, u'related': [u'disableAutoScaleVmGroup', u'createAutoScaleVmGroup', u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale vm group'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'id', u'required': False, u'related': [u'listAutoScalePolicies', u'updateAutoScalePolicy', u'createAutoScalePolicy'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale policy'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'conditionid', u'required': False, u'related': [u'listConditions'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the condition of the policy'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'action', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the action to be executed if all the conditions evaluate to true for the specified duration.'}], u'requiredparams': [], u'description': u'Lists autoscale policies.'}, u'internalloadbalancerelements': {u'name': u'listInternalLoadBalancerElements', u'related': [u'createInternalLoadBalancerElement', u'configureInternalLoadBalancerElement'], u'isasync': False, u'params': [{u'name': u'nspid', u'required': False, u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider', u'listTrafficTypes'], u'length': 255, u'type': u'uuid', u'description': u'list internal load balancer elements by network service provider id'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listInternalLoadBalancerElements', u'createInternalLoadBalancerElement', u'configureInternalLoadBalancerElement'], u'length': 255, u'type': u'uuid', u'description': u'list internal load balancer elements by id'}, {u'name': u'enabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list internal load balancer elements by enabled state'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all available Internal Load Balancer elements.'}, u'templatepermissions': {u'name': u'listTemplatePermissions', u'related': [u'listIsoPermissions'], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listTemplatePermissions', u'listIsoPermissions'], u'length': 255, u'type': u'uuid', u'description': u'the template ID'}], u'requiredparams': [u'id'], u'description': u'List template visibility and all accounts that have permissions to view this template.'}, u'projects': {u'name': u'listProjects', u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'isasync': False, u'params': [{u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list projects by display text'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list projects by project ID'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list projects by name'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List projects by tags (key/value pairs)'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list projects by state'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}], u'requiredparams': [], u'description': u'Lists projects and provides detailed information for listed projects'}, u'systemvms': {u'name': u'listSystemVms', u'related': [u'scaleSystemVm', u'rebootSystemVm'], u'isasync': False, u'params': [{u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the state of the system VM'}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID of the system VM'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'hostid', u'required': False, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'the host ID of the system VM'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID of the system VM'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the system VM'}, {u'name': u'id', u'required': False, u'related': [u'scaleSystemVm', u'listSystemVms', u'rebootSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the system VM'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'systemvmtype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the system VM type. Possible types are "consoleproxy" and "secondarystoragevm".'}, {u'name': u'storageid', u'required': False, u'related': [u'findStoragePoolsForMigration'], u'length': 255, u'type': u'uuid', u'description': u"the storage ID where vm's volumes belong to"}], u'requiredparams': [], u'description': u'List system virtual machines.'}, u'portforwardingrules': {u'name': u'listPortForwardingRules', u'related': [u'createPortForwardingRule', u'listIpForwardingRules'], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'id', u'required': False, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'Lists rule with the specified ID.'}, {u'name': u'ipaddressid', u'required': False, u'related': [u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the id of IP address of the port forwarding services'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [], u'description': u'Lists all port forwarding rules for an IP address.'}, u'networkacllists': {u'name': u'listNetworkACLLists', u'related': [u'createNetworkACLList'], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network ACLs by specified name'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'vpcid', u'required': False, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'list network ACLs by Vpc Id'}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'list network ACLs by network Id'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'createNetworkACLList', u'listNetworkACLLists'], u'length': 255, u'type': u'uuid', u'description': u'Lists network ACL with the specified ID.'}], u'requiredparams': [], u'description': u'Lists all network ACLs'}, u'storageproviders': {u'name': u'listStorageProviders', u'related': [], u'isasync': False, u'params': [{u'name': u'type', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the type of storage provider: either primary or image'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'type'], u'description': u'Lists storage providers.'}, u'vpngateways': {u'name': u'listVpnGateways', u'related': [u'createVpnGateway'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listVpnGateways', u'createVpnGateway'], u'length': 255, u'type': u'uuid', u'description': u'id of the vpn gateway'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'vpcid', u'required': False, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'id of vpc'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists site 2 site vpn gateways'}, u'events': {u'name': u'listEvents', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the event type (see event types)'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'duration', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the duration of the event'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'id', u'required': False, u'related': [u'listEvents'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the event'}, {u'name': u'level', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the event level (INFO, WARN, ERROR)'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'enddate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")'}, {u'name': u'entrytime', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the time the event was entered'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'startdate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")'}], u'requiredparams': [], u'description': u'A command to list events.'}, u'loadbalancerruleinstances': {u'name': u'listLoadBalancerRuleInstances', u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': True, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'applied', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if listing all virtual machines currently applied to the load balancer rule; default is true'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [u'id'], u'description': u'List all virtual machine instances that are assigned to a load balancer rule.'}, u'hosts': {u'name': u'listHosts', u'related': [], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the host'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'clusterid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'lists hosts existing in particular cluster'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the host'}, {u'name': u'id', u'required': False, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'the id of the host'}, {u'name': u'resourcestate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list hosts by resource state. Resource state represents current state determined by admin of host, valule can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID for the host'}, {u'name': u'hahost', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true, list only hosts dedicated to HA'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the state of the host'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the host type'}, {u'name': u'virtualmachineid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM'}], u'requiredparams': [], u'description': u'Lists hosts.'}, u'hypervisorcapabilities': {u'name': u'listHypervisorCapabilities', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the hypervisor for which to restrict the search'}, {u'name': u'id', u'required': False, u'related': [u'listHypervisorCapabilities'], u'length': 255, u'type': u'uuid', u'description': u'ID of the hypervisor capability'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all hypervisor capabilities.'}, u'configurations': {u'name': u'listConfigurations', u'related': [], u'isasync': False, u'params': [{u'name': u'category', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists configurations by category'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists configuration by name'}, {u'name': u'accountid', u'required': False, u'related': [u'listAccounts', u'disableAccount', u'lockAccount', u'createAccount', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Account to update the parameter value for corresponding account'}, {u'name': u'clusterid', u'required': False, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Cluster to update the parameter value for corresponding cluster'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Zone to update the parameter value for corresponding zone'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'storageid', u'required': False, u'related': [u'findStoragePoolsForMigration', u'createStoragePool', u'listStoragePools'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Storage pool to update the parameter value for corresponding storage pool'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all configurations.'}, u'usagerecords': {u'name': u'listUsageRecords', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'List usage records for specified project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'List usage records for the specified domain.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'startdate', u'required': True, u'related': [], u'length': 255, u'type': u'date', u'description': u'Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.'}, {u'name': u'accountid', u'required': False, u'related': [u'listAccounts', u'disableAccount', u'lockAccount', u'createAccount', u'updateAccount', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'List usage records for the specified account'}, {u'name': u'enddate', u'required': True, u'related': [], u'length': 255, u'type': u'date', u'description': u'End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'List usage records for the specified usage type'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List usage records for the specified user.'}], u'requiredparams': [u'startdate', u'enddate'], u'description': u'Lists usage records for accounts'}, u'storagepools': {u'name': u'listStoragePools', u'related': [u'findStoragePoolsForMigration'], u'isasync': False, u'params': [{u'name': u'id', u'required': False, u'related': [u'findStoragePoolsForMigration', u'listStoragePools'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the storage pool'}, {u'name': u'clusterid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list storage pools belongig to the specific cluster'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the storage pool'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID for the storage pool'}, {u'name': u'scope', u'required': False, u'related': [u'findStoragePoolsForMigration', u'listStoragePools'], u'length': 255, u'type': u'string', u'description': u'the ID of the storage pool'}, {u'name': u'ipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the IP address for the storage pool'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the storage pool'}, {u'name': u'path', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the storage pool path'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [], u'description': u'Lists storage pools.'}, u'ucsblades': {u'name': u'listUcsBlades', u'related': [], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'ucsmanagerid', u'required': True, u'related': [u'addUcsManager'], u'length': 255, u'type': u'uuid', u'description': u'ucs manager id'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'ucsmanagerid'], u'description': u'List ucs blades'}, u'snapshots': {u'name': u'listSnapshots', u'related': [u'createSnapshot'], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'list snapshots by zone id'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'volumeid', u'required': False, u'related': [u'createVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'snapshottype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'valid values are MANUAL or RECURRING.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists snapshot by snapshot name'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'intervaltype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.'}, {u'name': u'id', u'required': False, u'related': [u'createSnapshot', u'listSnapshots'], u'length': 255, u'type': u'uuid', u'description': u'lists snapshot by snapshot ID'}], u'requiredparams': [], u'description': u'Lists all available snapshots for the account.'}, u'zones': {u'name': u'listZones', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': False, u'related': [u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the zone'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'showcapacities', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'flag to display the capacity of the zones'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain associated with the zone'}, {u'name': u'networktype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the network type of the zone that the virtual machine belongs to'}, {u'name': u'available', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.'}], u'requiredparams': [], u'description': u'Lists zones'}, u'serviceofferings': {u'name': u'listServiceOfferings', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listServiceOfferings'], u'length': 255, u'type': u'uuid', u'description': u'ID of the service offering'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'restoreVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain associated with the service offering'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the service offering'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'systemvmtype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter".'}, {u'name': u'issystem', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'is this a system vm offering'}], u'requiredparams': [], u'description': u'Lists all available service offerings.'}, u'affinitygrouptypes': {u'name': u'listAffinityGroupTypes', u'related': [], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists affinity group types available'}, u'publicipaddresses': {u'name': u'listPublicIpAddresses', u'related': [u'associateIpAddress', u'restartNetwork'], u'isasync': False, u'params': [{u'name': u'forloadbalancing', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list only ips used for load balancing'}, {u'name': u'associatednetworkid', u'required': False, u'related': [u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'lists all public IP addresses associated to the network specified'}, {u'name': u'allocatedonly', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'limits search results to allocated public IP addresses'}, {u'name': u'vpcid', u'required': False, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'List ips belonging to the VPC'}, {u'name': u'forvirtualnetwork', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'the virtual network for the IP address'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'lists all public IP addresses by Zone ID'}, {u'name': u'vlanid', u'required': False, u'related': [u'listVlanIpRanges', u'dedicatePublicIpRange', u'createVlanIpRange'], u'length': 255, u'type': u'uuid', u'description': u'lists all public IP addresses by VLAN ID'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'id', u'required': False, u'related': [u'listPublicIpAddresses', u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'lists ip address by id'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork'], u'length': 255, u'type': u'uuid', u'description': u'lists all public IP addresses by physical network id'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'issourcenat', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list only source nat ip addresses'}, {u'name': u'isstaticnat', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list only static nat ip addresses'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'ipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists the specified IP address'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [], u'description': u'Lists all public ip addresses'}, u'networkserviceproviders': {u'name': u'listNetworkServiceProviders', u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider', u'listTrafficTypes'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list providers by name'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list providers by state'}, {u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork', u'updatePhysicalNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID'}], u'requiredparams': [], u'description': u'Lists network serviceproviders for a given physical network.'}, u'capacity': {u'name': u'listCapacity', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'lists capacity by the Zone ID'}, {u'name': u'fetchlatest', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'recalculate capacities and fetch the latest'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9.'}, {u'name': u'podid', u'required': False, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'lists capacity by the Pod ID'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'clusterid', u'required': False, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'lists capacity by the Cluster ID'}, {u'name': u'sortby', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Sort the results. Available values: Usage'}], u'requiredparams': [], u'description': u'Lists all the system wide capacities.'}, u'diskofferings': {u'name': u'listDiskOfferings', u'related': [u'createDiskOffering'], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain of the disk offering.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the disk offering'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listDiskOfferings', u'createDiskOffering'], u'length': 255, u'type': u'uuid', u'description': u'ID of the disk offering'}], u'requiredparams': [], u'description': u'Lists all available disk offerings.'}, u'lbstickinesspolicies': {u'name': u'listLBStickinessPolicies', u'related': [u'createLBStickinessPolicy'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'lbruleid', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'lbruleid'], u'description': u'Lists LBStickiness policies.'}, u'networks': {u'name': u'listNetworks', u'related': [u'updateNetwork'], u'isasync': False, u'params': [{u'name': u'canusefordeploy', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list networks available for vm deployment'}, {u'name': u'issystem', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if network is system, false otherwise'}, {u'name': u'acltype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list networks by ACL (access control list) type. Supported values are Account and Domain'}, {u'name': u'forvpc', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'the network belongs to vpc'}, {u'name': u'id', u'required': False, u'related': [u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'list networks by id'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'supportedservices', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list networks supporting certain services'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the type of the network. Supported values are: Isolated and Shared'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork'], u'length': 255, u'type': u'uuid', u'description': u'list networks by physical network id'}, {u'name': u'restartrequired', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list networks by restartRequired'}, {u'name': u'vpcid', u'required': False, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'List networks by VPC'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID of the network'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'specifyipranges', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if need to list only networks which support specifying ip ranges'}, {u'name': u'traffictype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of the traffic'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}], u'requiredparams': [], u'description': u'Lists all available networks.'}, u'securitygroups': {u'name': u'listSecurityGroups', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listSecurityGroups'], u'length': 255, u'type': u'uuid', u'description': u'list the security group by the id provided'}, {u'name': u'securitygroupname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists security groups by name'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'lists security groups by virtual machine id'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}], u'requiredparams': [], u'description': u'Lists security groups'}, u'dedicatedzones': {u'name': u'listDedicatedZones', u'related': [], u'isasync': False, u'params': [{u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Zone'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain associated with the zone'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account associated with the zone. Must be used with domainId.'}, {u'name': u'affinitygroupid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list dedicated zones by affinity group'}], u'requiredparams': [], u'description': u'List dedicated zones.'}, u'baremetaldhcp': {u'name': u'listBaremetalDhcp', u'related': [u'addBaremetalDhcp'], u'isasync': False, u'params': [{u'name': u'dhcpservertype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Type of DHCP device'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'DHCP server device ID'}], u'requiredparams': [], u'description': u'list baremetal dhcp servers'}, u'conditions': {u'name': u'listConditions', u'related': [], u'isasync': False, u'params': [{u'name': u'counterid', u'required': False, u'related': [u'createCounter'], u'length': 255, u'type': u'uuid', u'description': u'Counter-id of the condition.'}, {u'name': u'policyid', u'required': False, u'related': [u'createAutoScalePolicy'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the policy'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listConditions'], u'length': 255, u'type': u'uuid', u'description': u'ID of the Condition.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}], u'requiredparams': [], u'description': u'List Conditions for the specific user'}, u'swifts': {u'name': u'listSwifts', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'the id of the swift'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'List Swift.'}, u'counters': {u'name': u'listCounters', u'related': [u'createCounter'], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listCounters', u'createCounter'], u'length': 255, u'type': u'uuid', u'description': u'ID of the Counter.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of the counter.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'source', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Source of the counter.'}], u'requiredparams': [], u'description': u'List the counters'}, u'tags': {u'name': u'listTags', u'related': [u'listResourceDetails'], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'key', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by key'}, {u'name': u'resourceid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by resource id'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'resourcetype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by resource type'}, {u'name': u'value', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by value'}, {u'name': u'customer', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by customer name'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}], u'requiredparams': [], u'description': u'List resource tag(s)'}, u'routers': {u'name': u'listRouters', u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'startInternalLoadBalancerVM', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'stopRouter', u'rebootRouter', u'destroyRouter'], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'forvpc', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true is passed for this parameter, list only VPC routers'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'id', u'required': False, u'related': [u'listLoadBalancerRuleInstances', u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'addNicToVirtualMachine', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk router'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject', u'suspendProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the router'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'vpcid', u'required': False, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'List networks by VPC'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the state of the router'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'podid', u'required': False, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID of the router'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID of the router'}, {u'name': u'networkid', u'required': False, u'related': [u'createNetwork', u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'list by network id'}, {u'name': u'hostid', u'required': False, u'related': [u'addHost', u'updateHost', u'addBaremetalHost', u'listHosts', u'cancelHostMaintenance', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the host ID of the router'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'List routers.'}, u'projectinvitations': {u'name': u'listProjectInvitations', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listProjectInvitations'], u'length': 255, u'type': u'uuid', u'description': u'list invitations by id'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'activeonly', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true, list only active invitations - having Pending state and ones that are not timed out yet'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list by project id'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list invitations by state'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}], u'requiredparams': [], u'description': u'Lists projects and provides detailed information for listed projects'}, u'isos': {u'name': u'listIsos', u'related': [], u'isasync': False, u'params': [{u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isready', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if this ISO is ready to be deployed'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'bootable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the ISO is bootable, false otherwise'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'id', u'required': False, u'related': [u'listIsos'], u'length': 255, u'type': u'uuid', u'description': u'list ISO by id'}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the hypervisor for which to restrict the search'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list all isos by name'}, {u'name': u'isofilter', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'ispublic', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the ISO is publicly available to all users, false otherwise.'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [], u'description': u'Lists all available ISO files.'}, u'storagenetworkiprange': {u'name': u'listStorageNetworkIpRange', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listStorageNetworkIpRange'], u'length': 255, u'type': u'uuid', u'description': u'optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.'}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.'}], u'requiredparams': [], u'description': u'List a storage network IP range.'}, u'sshkeypairs': {u'name': u'listSSHKeyPairs', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'A key pair name to look for'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'fingerprint', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'A public key fingerprint to look for'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}], u'requiredparams': [], u'description': u'List registered keypairs'}, u'privategateways': {u'name': u'listPrivateGateways', u'related': [u'createPrivateGateway'], u'isasync': False, u'params': [{u'name': u'ipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list gateways by ip address'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'vpcid', u'required': False, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'list gateways by vpc'}, {u'name': u'id', u'required': False, u'related': [u'createPrivateGateway', u'listPrivateGateways'], u'length': 255, u'type': u'uuid', u'description': u'list private gateway by id'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list gateways by vlan'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list gateways by state'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'List private gateways'}, u'internalloadbalancervms': {u'name': u'listInternalLoadBalancerVMs', u'related': [], u'isasync': False, u'params': [{u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID of the Internal LB VM'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'hostid', u'required': False, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'the host ID of the Internal LB VM'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID of the Internal LB VM'}, {u'name': u'vpcid', u'required': False, u'related': [u'restartVPC'], u'length': 255, u'type': u'uuid', u'description': u'List Internal LB VMs by VPC'}, {u'name': u'networkid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list by network id'}, {u'name': u'forvpc', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true is passed for this parameter, list only VPC Internal LB VMs'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the state of the Internal LB VM'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the Internal LB VM'}, {u'name': u'id', u'required': False, u'related': [u'revertToVMSnapshot', u'listVirtualMachines'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Internal LB VM'}], u'requiredparams': [], u'description': u'List internal LB VMs.'}, u'dedicatedpods': {u'name': u'listDedicatedPods', u'related': [u'dedicatePod'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account associated with the pod. Must be used with domainId.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain associated with the pod'}, {u'name': u'affinitygroupid', u'required': False, u'related': [u'createAffinityGroup', u'listAffinityGroups'], u'length': 255, u'type': u'uuid', u'description': u'list dedicated pods by affinity group'}, {u'name': u'podid', u'required': False, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the pod'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists dedicated pods.'}, u'dedicatedclusters': {u'name': u'listDedicatedClusters', u'related': [u'dedicateCluster'], u'isasync': False, u'params': [{u'name': u'affinitygroupid', u'required': False, u'related': [u'listAffinityGroups'], u'length': 255, u'type': u'uuid', u'description': u'list dedicated clusters by affinity group'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain associated with the cluster'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account associated with the cluster. Must be used with domainId.'}, {u'name': u'clusterid', u'required': False, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the cluster'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists dedicated clusters.'}, u'usagetypes': {u'name': u'listUsageTypes', u'related': [], u'isasync': False, u'params': [], u'requiredparams': [], u'description': u'List Usage Types'}, u'domainchildren': {u'name': u'listDomainChildren', u'related': [], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list children domains by name'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'to return the entire tree, use the value "true". To return the first level children, use the value "false".'}, {u'name': u'id', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'list children domain by parent domain ID.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}], u'requiredparams': [], u'description': u'Lists all children domains belonging to a specified domain'}, u'domains': {u'name': u'listDomains', u'related': [u'listDomainChildren', u'updateDomain'], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'List domain by domain ID.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List domain by domain name.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'level', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'List domains by domain level.'}], u'requiredparams': [], u'description': u'Lists domains and provides detailed information for listed domains'}, u'networkisolationmethods': {u'name': u'listNetworkIsolationMethods', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists supported methods of network isolation'}, u's3s': {u'name': u'listS3s', u'related': [u'listSecondaryStagingStores', u'listSwifts', u'addS3', u'createSecondaryStagingStore', u'addImageStore', u'addSwift'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists S3s'}, u'hypervisors': {u'name': u'listHypervisors', u'related': [], u'isasync': False, u'params': [{u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the zone id for listing hypervisors.'}], u'requiredparams': [], u'description': u'List hypervisors'}, u'accounts': {u'name': u'listAccounts', u'related': [u'markDefaultZoneForAccount'], u'isasync': False, u'params': [{u'name': u'accounttype', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).'}, {u'name': u'id', u'required': False, u'related': [u'listAccounts', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'list account by account ID'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list accounts by state. Valid states are enabled, disabled, and locked.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list account by account name'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'iscleanuprequired', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list accounts by cleanuprequred attribute (values are true or false)'}], u'requiredparams': [], u'description': u'Lists accounts and provides detailed account information for listed accounts'}, u'networkdevice': {u'name': u'listNetworkDevice', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'networkdevicetype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall'}, {u'name': u'networkdeviceparameterlist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'parameters for network device'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'List network devices'}, u'vlanipranges': {u'name': u'listVlanIpRanges', u'related': [], u'isasync': False, u'params': [{u'name': u'networkid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'network id of the VLAN IP range'}, {u'name': u'forvirtualnetwork', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if VLAN is of Virtual type, false if Direct'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account with which the VLAN IP range is associated. Must be used with the domainId parameter.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID of the VLAN IP range'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ID or VID of the VLAN. Default is an "untagged" VLAN.'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID of the VLAN IP range'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.'}, {u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'physical network id of the VLAN IP range'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'project who will own the VLAN'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listVlanIpRanges'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the VLAN IP range'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all VLAN IP ranges.'}, u'traffictypeimplementors': {u'name': u'listTrafficTypeImplementors', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'traffictype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists implementors of implementor of a network traffic type or implementors of all network traffic types'}, u'isopermissions': {u'name': u'listIsoPermissions', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listIsoPermissions'], u'length': 255, u'type': u'uuid', u'description': u'the template ID'}], u'requiredparams': [u'id'], u'description': u'List iso visibility and all accounts that have permissions to view this iso.'}, u'snapshotpolicies': {u'name': u'listSnapshotPolicies', u'related': [u'createSnapshotPolicy'], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'volumeid', u'required': True, u'related': [u'detachVolume', u'createVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'volumeid'], u'description': u'Lists snapshot policies.'}, u'loadbalancers': {u'name': u'listLoadBalancers', u'related': [u'createLoadBalancer'], u'isasync': False, u'params': [{u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the Load Balancer'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'networkid', u'required': False, u'related': [u'createNetwork', u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the network id of the Load Balancer'}, {u'name': u'id', u'required': False, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Load Balancer'}, {u'name': u'scheme', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the scheme of the Load Balancer. Supported value is Internal in the current release'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'sourceipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the source ip address of the Load Balancer'}, {u'name': u'sourceipaddressnetworkid', u'required': False, u'related': [u'createNetwork', u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the network id of the source ip address'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}], u'requiredparams': [], u'description': u'Lists Load Balancers'}, u'imagestores': {u'name': u'listImageStores', u'related': [u'listSecondaryStagingStores', u'listSwifts', u'addS3', u'listS3s', u'createSecondaryStagingStore', u'addImageStore', u'addSwift'], u'isasync': False, u'params': [{u'name': u'protocol', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the image store protocol'}, {u'name': u'id', u'required': False, u'related': [u'listSecondaryStagingStores', u'listImageStores', u'listSwifts', u'addS3', u'listS3s', u'createSecondaryStagingStore', u'addImageStore', u'addSwift'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the storage pool'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'provider', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the image store provider'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the image store'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the image store'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists image stores.'}, u'autoscalevmgroups': {u'name': u'listAutoScaleVmGroups', u'related': [u'disableAutoScaleVmGroup', u'createAutoScaleVmGroup', u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the availability zone ID'}, {u'name': u'lbruleid', u'required': False, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the loadbalancer'}, {u'name': u'vmprofileid', u'required': False, u'related': [u'updateAutoScaleVmProfile', u'createAutoScaleVmProfile', u'listAutoScaleVmProfiles'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the profile'}, {u'name': u'policyid', u'required': False, u'related': [u'listAutoScalePolicies', u'updateAutoScalePolicy', u'createAutoScalePolicy'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the policy'}, {u'name': u'id', u'required': False, u'related': [u'disableAutoScaleVmGroup', u'listAutoScaleVmGroups', u'createAutoScaleVmGroup', u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale vm group'}], u'requiredparams': [], u'description': u'Lists autoscale vm groups.'}, u'projectaccounts': {u'name': u'listProjectAccounts', u'related': [u'updateProject', u'createProject'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list accounts of the project by account name'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'projectid', u'required': True, u'related': [u'updateProject', u'createProject', u'listProjectAccounts'], u'length': 255, u'type': u'uuid', u'description': u'id of the project'}, {u'name': u'role', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list accounts of the project by role'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'projectid'], u'description': u"Lists project's accounts"}, u'autoscalevmprofiles': {u'name': u'listAutoScaleVmProfiles', u'related': [], u'isasync': False, u'params': [{u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'templateid', u'required': False, u'related': [u'listIsos', u'updateIso'], u'length': 255, u'type': u'uuid', u'description': u'the templateid of the autoscale vm profile'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listAutoScaleVmProfiles'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale vm profile'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'otherdeployparams', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the otherdeployparameters of the autoscale vm profile'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}], u'requiredparams': [], u'description': u'Lists autoscale vm profiles.'}, u'apis': {u'name': u'listApis', u'related': [], u'isasync': False, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'API name'}], u'requiredparams': [], u'description': u'lists all available apis on the server, provided by the Api Discovery plugin'}, u'vpcs': {u'name': u'listVPCs', u'related': [u'restartVPC'], u'isasync': False, u'params': [{u'name': u'vpcofferingid', u'required': False, u'related': [u'listVPCOfferings'], u'length': 255, u'type': u'uuid', u'description': u'list by ID of the VPC offering'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'restartrequired', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list VPCs by restartRequired option'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list by zone'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by display text of the VPC'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list VPCs by state'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by name of the VPC'}, {u'name': u'cidr', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR"}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'supportedservices', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list VPC supporting certain services'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'id', u'required': False, u'related': [u'restartVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'list VPC by id'}], u'requiredparams': [], u'description': u'Lists VPCs'}, u'resourcedetails': {u'name': u'listResourceDetails', u'related': [], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'resourcetype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by resource type'}, {u'name': u'key', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by key'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'resourceid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by resource id'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'List resource detail(s)'}, u'vpncustomergateways': {u'name': u'listVpnCustomerGateways', u'related': [u'updateVpnCustomerGateway'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'id', u'required': False, u'related': [u'listVpnCustomerGateways', u'updateVpnCustomerGateway'], u'length': 255, u'type': u'uuid', u'description': u'id of the customer gateway'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists site to site vpn customer gateways'}, u'dedicatedhosts': {u'name': u'listDedicatedHosts', u'related': [u'dedicateHost'], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account associated with the host. Must be used with domainId.'}, {u'name': u'hostid', u'required': False, u'related': [u'addHost', u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the host'}, {u'name': u'affinitygroupid', u'required': False, u'related': [u'listAffinityGroups'], u'length': 255, u'type': u'uuid', u'description': u'list dedicated hosts by affinity group'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain associated with the host'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists dedicated hosts.'}, u'capabilities': {u'name': u'listCapabilities', u'related': [], u'isasync': False, u'params': [], u'requiredparams': [], u'description': u'Lists capabilities'}, u'dedicatedguestvlanranges': {u'name': u'listDedicatedGuestVlanRanges', u'related': [u'dedicateGuestVlanRange'], u'isasync': False, u'params': [{u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'physical network id of the guest VLAN range'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'project who will own the guest VLAN range'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account with which the guest VLAN range is associated. Must be used with the domainId parameter.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'guestvlanrange', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the dedicated guest vlan range'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listDedicatedGuestVlanRanges', u'dedicateGuestVlanRange'], u'length': 255, u'type': u'uuid', u'description': u'list dedicated guest vlan ranges by id'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'zone of the guest VLAN range'}], u'requiredparams': [], u'description': u'Lists dedicated guest vlan ranges'}, u'virtualmachines': {u'name': u'listVirtualMachines', u'related': [], u'isasync': False, u'params': [{u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the availability zone ID'}, {u'name': u'groupid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the group ID'}, {u'name': u'id', u'required': False, u'related': [u'listVirtualMachines'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'state of the virtual machine'}, {u'name': u'networkid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list by network id'}, {u'name': u'hostid', u'required': False, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'the host ID'}, {u'name': u'forvirtualnetwork', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list by network type; true if need to list vms using Virtual Network, false otherwise'}, {u'name': u'vpcid', u'required': False, u'related': [u'restartVPC'], u'length': 255, u'type': u'uuid', u'description': u'list vms by vpc'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isoid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list vms by iso'}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'the pod ID'}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the virtual machine'}, {u'name': u'storageid', u'required': False, u'related': [u'findStoragePoolsForMigration'], u'length': 255, u'type': u'uuid', u'description': u"the storage ID where vm's volumes belong to"}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'affinitygroupid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list vms by affinity group'}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the target hypervisor for the template'}, {u'name': u'templateid', u'required': False, u'related': [u'listIsos'], u'length': 255, u'type': u'uuid', u'description': u'list vms by template'}], u'requiredparams': [], u'description': u'List the virtual machines owned by the account.'}, u'oscategories': {u'name': u'listOsCategories', u'related': [], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list os category by name'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listOsCategories'], u'length': 255, u'type': u'uuid', u'description': u'list Os category by id'}], u'requiredparams': [], u'description': u'Lists all supported OS categories for this cloud.'}, u'affinitygroups': {u'name': u'listAffinityGroups', u'related': [], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'lists affinity groups by virtual machine id'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists affinity groups by type'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listAffinityGroups'], u'length': 255, u'type': u'uuid', u'description': u'list the affinity group by the id provided'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'lists affinity groups by name'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}], u'requiredparams': [], u'description': u'Lists affinity groups'}, u'secondarystagingstores': {u'name': u'listSecondaryStagingStores', u'related': [u'listSwifts', u'createSecondaryStagingStore', u'addImageStore'], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'provider', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the staging store provider'}, {u'name': u'id', u'required': False, u'related': [u'listSecondaryStagingStores', u'listSwifts', u'createSecondaryStagingStore', u'addImageStore'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the staging store'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the staging store'}, {u'name': u'protocol', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the staging store protocol'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the staging store'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists secondary staging stores.'}, u'virtualrouterelements': {u'name': u'listVirtualRouterElements', u'related': [u'configureVirtualRouterElement', u'createVirtualRouterElement'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'enabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'list network offerings by enabled state'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'nspid', u'required': False, u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider', u'listTrafficTypes'], u'length': 255, u'type': u'uuid', u'description': u'list virtual router elements by network service provider id'}, {u'name': u'id', u'required': False, u'related': [u'configureVirtualRouterElement', u'createVirtualRouterElement', u'listVirtualRouterElements'], u'length': 255, u'type': u'uuid', u'description': u'list virtual router elements by id'}], u'requiredparams': [], u'description': u'Lists all available virtual router elements.'}, u'asyncjobs': {u'name': u'listAsyncJobs', u'related': [], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'startdate', u'required': False, u'related': [], u'length': 255, u'type': u'tzdate', u'description': u'the start date of the async job'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all pending asynchronous jobs for the account.'}, u'ostypes': {u'name': u'listOsTypes', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'oscategoryid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list by Os Category id'}, {u'name': u'id', u'required': False, u'related': [u'listOsTypes'], u'length': 255, u'type': u'uuid', u'description': u'list by Os type Id'}, {u'name': u'description', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list os by description'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all supported OS types for this cloud.'}, u'globalloadbalancerrules': {u'name': u'listGlobalLoadBalancerRules', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'regionid', u'required': False, u'related': [u'addRegion'], u'length': 255, u'type': u'integer', u'description': u'region ID'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'id', u'required': False, u'related': [u'listGlobalLoadBalancerRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the global load balancer rule'}], u'requiredparams': [], u'description': u'Lists load balancer rules.'}, u'networkacls': {u'name': u'listNetworkACLs', u'related': [u'createNetworkACL', u'updateNetworkACLItem'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'networkid', u'required': False, u'related': [u'createNetwork', u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'list network ACL Items by network Id'}, {u'name': u'protocol', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network ACL Items by Protocol'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'aclid', u'required': False, u'related': [u'createNetworkACLList', u'listNetworkACLLists'], u'length': 255, u'type': u'uuid', u'description': u'list network ACL Items by ACL Id'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject', u'suspendProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'traffictype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network ACL Items by traffic type - Ingress or Egress'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'action', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list network ACL Items by Action'}, {u'name': u'id', u'required': False, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'Lists network ACL Item with the specified ID'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}], u'requiredparams': [], u'description': u'Lists all network ACL items'}, u'eventtypes': {u'name': u'listEventTypes', u'related': [], u'isasync': False, u'params': [], u'requiredparams': [], u'description': u'List Event Types'}, u'remoteaccessvpns': {u'name': u'listRemoteAccessVpns', u'related': [u'createRemoteAccessVpn'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'publicipid', u'required': True, u'related': [u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'public ip address id of the vpn server'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'publicipid'], u'description': u'Lists remote access vpns'}, u'ucsprofiles': {u'name': u'listUcsProfiles', u'related': [], u'isasync': False, u'params': [{u'name': u'ucsmanagerid', u'required': True, u'related': [u'addUcsManager'], u'length': 255, u'type': u'uuid', u'description': u'the id for the ucs manager'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [u'ucsmanagerid'], u'description': u'List profile in ucs manager'}, u'nics': {u'name': u'listNics', u'related': [], u'isasync': False, u'params': [{u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the vm'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'nicid', u'required': False, u'related': [u'listNics'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the nic to to list IPs'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [u'virtualmachineid'], u'description': u'list the vm nics IP to NIC'}, u'alerts': {u'name': u'listAlerts', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listAlerts'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the alert'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list by alert type'}], u'requiredparams': [], u'description': u'Lists all alerts.'}, u'regions': {u'name': u'listRegions', u'related': [u'addRegion'], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'List Region by region ID.'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List Region by region name.'}], u'requiredparams': [], u'description': u'Lists Regions'}, u'vpcofferings': {u'name': u'listVPCOfferings', u'related': [], u'isasync': False, u'params': [{u'name': u'isdefault', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if need to list only default VPC offerings. Default value is false'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list VPC offerings by display text'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list VPC offerings by name'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list VPC offerings by state'}, {u'name': u'id', u'required': False, u'related': [u'listVPCOfferings'], u'length': 255, u'type': u'uuid', u'description': u'list VPC offerings by id'}, {u'name': u'supportedservices', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list VPC offerings supporting certain services'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists VPC offerings'}, u'baremetalpxeservers': {u'name': u'listBaremetalPxeServers', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'Pxe server device ID'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'list baremetal pxe server'}, u'templates': {u'name': u'listTemplates', u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'copyIso', u'prepareTemplate'], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the template name'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the hypervisor for which to restrict the search'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'templatefilter', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the template ID'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'list templates by zoneId'}], u'requiredparams': [u'templatefilter'], u'description': u'List all public, private, and privileged templates.'}, u'users': {u'name': u'listUsers', u'related': [], u'isasync': False, u'params': [{u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'username', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List user by the username'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List users by state of the user account.'}, {u'name': u'accounttype', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.'}, {u'name': u'id', u'required': False, u'related': [u'listUsers'], u'length': 255, u'type': u'uuid', u'description': u'List user by ID.'}], u'requiredparams': [], u'description': u'Lists user accounts'}, u'ipforwardingrules': {u'name': u'listIpForwardingRules', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': False, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'Lists rule with the specified ID.'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'revertToVMSnapshot', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'Lists all rules applied to the specified Vm.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'ipaddressid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list the rule belonging to this public ip address'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}], u'requiredparams': [], u'description': u'List the ip forwarding rules'}, u'deploymentplanners': {u'name': u'listDeploymentPlanners', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all DeploymentPlanners available.'}, u'vpnconnections': {u'name': u'listVpnConnections', u'related': [], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [u'listVpnConnections'], u'length': 255, u'type': u'uuid', u'description': u'id of the vpn connection'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'vpcid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'id of vpc'}], u'requiredparams': [], u'description': u'Lists site to site vpn connection gateways'}, u'trafficmonitors': {u'name': u'listTrafficMonitors', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'zone Id'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'zoneid'], u'description': u'List traffic monitor Hosts.'}, u'vpnusers': {u'name': u'listVpnUsers', u'related': [], u'isasync': False, u'params': [{u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'id', u'required': False, u'related': [u'listVpnUsers'], u'length': 255, u'type': u'uuid', u'description': u'The uuid of the Vpn user'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'username', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username of the vpn user.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}], u'requiredparams': [], u'description': u'Lists vpn users'}, u'egressfirewallrules': {u'name': u'listEgressFirewallRules', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'Lists rule with the specified ID.'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'networkid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the id network network for the egress firwall services'}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'Lists rule with the specified ID.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'ipaddressid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the id of IP address of the firwall services'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}], u'requiredparams': [], u'description': u'Lists all egress firewall rules for network id.'}, u'staticroutes': {u'name': u'listStaticRoutes', u'related': [], u'isasync': False, u'params': [{u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'vpcid', u'required': False, u'related': [u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'list static routes by vpc id'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'id', u'required': False, u'related': [u'listStaticRoutes'], u'length': 255, u'type': u'uuid', u'description': u'list static route by id'}, {u'name': u'gatewayid', u'required': False, u'related': [u'createPrivateGateway'], u'length': 255, u'type': u'uuid', u'description': u'list static routes by gateway id'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}], u'requiredparams': [], u'description': u'Lists all static routes'}, u'portableipranges': {u'name': u'listPortableIpRanges', u'related': [], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'listPortableIpRanges'], u'length': 255, u'type': u'uuid', u'description': u'Id of the portable ip range'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'regionid', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Id of a Region'}], u'requiredparams': [], u'description': u'list portable IP ranges'}, u'volumes': {u'name': u'listVolumes', u'related': [u'detachVolume', u'createVolume', u'migrateVolume', u'updateVolume', u'attachVolume', u'resizeVolume', u'uploadVolume'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list resources by account. Must be used with the domainId parameter.'}, {u'name': u'isrecursive', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the type of disk volume'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'list only resources belonging to the domain specified'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'listLoadBalancerRuleInstances', u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'List resources by tags (key/value pairs)'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the disk volume'}, {u'name': u'podid', u'required': False, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the pod id the disk volume belongs to'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject', u'suspendProject'], u'length': 255, u'type': u'uuid', u'description': u'list objects by project'}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'id', u'required': False, u'related': [u'detachVolume', u'createVolume', u'migrateVolume', u'updateVolume', u'attachVolume', u'resizeVolume', u'listVolumes', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the availability zone'}, {u'name': u'hostid', u'required': False, u'related': [u'addHost', u'updateHost', u'addBaremetalHost', u'listHosts', u'cancelHostMaintenance', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'list volumes on specified host'}], u'requiredparams': [], u'description': u'Lists all volumes.'}, u'pods': {u'name': u'listPods', u'related': [u'updatePod', u'createPod'], u'isasync': False, u'params': [{u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list pods by allocation state'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'list Pods by Zone ID'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list Pods by name'}, {u'name': u'showcapacities', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'flag to display the capacity of the pods'}, {u'name': u'id', u'required': False, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'list Pods by ID'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [], u'description': u'Lists all Pods.'}}, u'activate': {u'project': {u'name': u'activateProject', u'related': [u'updateProject', u'createProject', u'listProjectAccounts'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'id of the project to be modified'}], u'requiredparams': [u'id'], u'description': u'Activates a project'}}, u'reconnect': {u'host': {u'name': u'reconnectHost', u'related': [u'addHost', u'updateHost', u'addBaremetalHost', u'listHosts', u'cancelHostMaintenance', u'prepareHostForMaintenance'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'addHost', u'updateHost', u'addBaremetalHost', u'listHosts', u'reconnectHost', u'cancelHostMaintenance', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the host ID'}], u'requiredparams': [u'id'], u'description': u'Reconnects a host.'}}, u'cancel': {u'hostmaintenance': {u'name': u'cancelHostMaintenance', u'related': [u'addHost', u'updateHost', u'addBaremetalHost', u'listHosts', u'prepareHostForMaintenance'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'addHost', u'updateHost', u'addBaremetalHost', u'listHosts', u'cancelHostMaintenance', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the host ID'}], u'requiredparams': [u'id'], u'description': u'Cancels host maintenance.'}, u'storagemaintenance': {u'name': u'cancelStorageMaintenance', u'related': [u'findStoragePoolsForMigration', u'createStoragePool', u'listStoragePools'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'findStoragePoolsForMigration', u'cancelStorageMaintenance', u'createStoragePool', u'listStoragePools'], u'length': 255, u'type': u'uuid', u'description': u'the primary storage ID'}], u'requiredparams': [u'id'], u'description': u'Cancels maintenance for primary storage'}}, u'query': {u'asyncjobresult': {u'name': u'queryAsyncJobResult', u'related': [u'listAsyncJobs'], u'isasync': False, u'params': [{u'name': u'jobid', u'required': True, u'related': [u'listAsyncJobs', u'queryAsyncJobResult'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the asychronous job'}], u'requiredparams': [u'jobid'], u'description': u'Retrieves the current status of asynchronous job.'}}, u'recover': {u'virtualmachine': {u'name': u'recoverVirtualMachine', u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}], u'requiredparams': [u'id'], u'description': u'Recovers a virtual machine.'}}, u'extract': {u'volume': {u'name': u'extractVolume', u'related': [u'extractIso', u'extractTemplate'], u'isasync': True, u'params': [{u'name': u'url', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the url to which the volume would be extracted'}, {u'name': u'mode', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone where the volume is located'}, {u'name': u'id', u'required': True, u'related': [u'detachVolume', u'createVolume', u'migrateVolume', u'updateVolume', u'attachVolume', u'resizeVolume', u'listVolumes', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the volume'}], u'requiredparams': [u'mode', u'zoneid', u'id'], u'description': u'Extracts volume'}, u'iso': {u'name': u'extractIso', u'related': [u'extractTemplate'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listIsos', u'updateIso', u'copyIso'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the ISO file'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone where the ISO is originally located'}, {u'name': u'url', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the url to which the ISO would be extracted'}, {u'name': u'mode', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD'}], u'requiredparams': [u'id', u'mode'], u'description': u'Extracts an ISO'}, u'template': {u'name': u'extractTemplate', u'related': [], u'isasync': True, u'params': [{u'name': u'url', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the url to which the ISO would be extracted'}, {u'name': u'mode', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD'}, {u'name': u'id', u'required': True, u'related': [u'listIsos', u'updateIso', u'copyIso'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the template'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone where the ISO is originally located'}], u'requiredparams': [u'mode', u'id'], u'description': u'Extracts a template'}}, u'archive': {u'alerts': {u'name': u'archiveAlerts', u'related': [], u'isasync': False, u'params': [{u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'archive by alert type'}, {u'name': u'startdate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'start date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}, {u'name': u'ids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the IDs of the alerts'}, {u'name': u'enddate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'end date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}], u'requiredparams': [], u'description': u'Archive one or more alerts.'}, u'events': {u'name': u'archiveEvents', u'related': [], u'isasync': False, u'params': [{u'name': u'enddate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'end date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}, {u'name': u'ids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the IDs of the events'}, {u'name': u'startdate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'start date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'archive by event type'}], u'requiredparams': [], u'description': u'Archive one or more events.'}}, u'scale': {u'systemvm': {u'name': u'scaleSystemVm', u'related': [], u'isasync': True, u'params': [{u'name': u'serviceofferingid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the service offering ID to apply to the system vm'}, {u'name': u'id', u'required': True, u'related': [u'scaleSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the system vm'}], u'requiredparams': [u'serviceofferingid', u'id'], u'description': u'Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.'}, u'virtualmachine': {u'name': u'scaleVirtualMachine', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}, {u'name': u'serviceofferingid', u'required': True, u'related': [u'listServiceOfferings', u'createServiceOffering'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the service offering for the virtual machine'}], u'requiredparams': [u'id', u'serviceofferingid'], u'description': u'Scales the virtual machine to a new service offering.'}}, u'prepare': {u'hostformaintenance': {u'name': u'prepareHostForMaintenance', u'related': [u'listHosts'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the host ID'}], u'requiredparams': [u'id'], u'description': u'Prepares a host for maintenance.'}, u'template': {u'name': u'prepareTemplate', u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'copyIso'], u'isasync': False, u'params': [{u'name': u'templateid', u'required': True, u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'template ID of the template to be prepared in primary storage(s).'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'zone ID of the template to be prepared in primary storage(s).'}], u'requiredparams': [u'templateid', u'zoneid'], u'description': u'load template into primary storage'}}, u'attach': {u'volume': {u'name': u'attachVolume', u'related': [u'detachVolume', u'createVolume', u'updateVolume', u'resizeVolume', u'uploadVolume'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'detachVolume', u'createVolume', u'updateVolume', u'attachVolume', u'resizeVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}, {u'name': u'deviceid', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u' the ID of the virtual machine'}], u'requiredparams': [u'id', u'virtualmachineid'], u'description': u'Attaches a disk volume to a virtual machine.'}, u'iso': {u'name': u'attachIso', u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the ISO file'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine'}], u'requiredparams': [u'id', u'virtualmachineid'], u'description': u'Attaches an ISO to a virtual machine.'}}, u'create': {u'loadbalancerrule': {u'name': u'createLoadBalancerRule', u'related': [], u'isasync': True, u'params': [{u'name': u'privateport', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the private port of the private ip address/virtual machine where the network traffic will be load balanced to'}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)'}, {u'name': u'openfirewall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true'}, {u'name': u'publicport', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the public port from where the network traffic will be load balanced from'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the load balancer rule'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list to forward traffic from'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID associated with the load balancer'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm'}, {u'name': u'algorithm', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'load balancer algorithm (source, roundrobin, leastconn)'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account associated with the load balancer. Must be used with the domainId parameter.'}, {u'name': u'publicipid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'public ip address id from where the network traffic will be load balanced from'}, {u'name': u'description', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the description of the load balancer rule'}], u'requiredparams': [u'privateport', u'publicport', u'name', u'algorithm'], u'description': u'Creates a load balancer rule'}, u'domain': {u'name': u'createDomain', u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'isasync': False, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'creates domain with this name'}, {u'name': u'networkdomain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Network domain for networks in the domain'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Domain UUID, required for adding domain from another Region'}, {u'name': u'parentdomainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'assigns new domain a parent domain by domain ID of the parent. If no parent domain is specied, the ROOT domain is assumed.'}], u'requiredparams': [u'name'], u'description': u'Creates a domain'}, u'snapshotpolicy': {u'name': u'createSnapshotPolicy', u'related': [], u'isasync': False, u'params': [{u'name': u'intervaltype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'valid values are HOURLY, DAILY, WEEKLY, and MONTHLY'}, {u'name': u'timezone', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.'}, {u'name': u'volumeid', u'required': True, u'related': [u'createVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}, {u'name': u'schedule', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)'}, {u'name': u'maxsnaps', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'maximum number of snapshots to retain'}], u'requiredparams': [u'intervaltype', u'timezone', u'volumeid', u'schedule', u'maxsnaps'], u'description': u'Creates a snapshot policy for the account.'}, u'diskoffering': {u'name': u'createDiskOffering', u'related': [], u'isasync': False, u'params': [{u'name': u'iopswriterate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'io requests write rate of the disk offering'}, {u'name': u'iopsreadrate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'io requests read rate of the disk offering'}, {u'name': u'disksize', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'size of the disk offering in GB'}, {u'name': u'customized', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'whether disk offering size is custom or not'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the containing domain, null for public offerings'}, {u'name': u'customizediops', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'whether disk offering iops is custom or not'}, {u'name': u'storagetype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the storage type of the disk offering. Values are local and shared.'}, {u'name': u'miniops', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'min iops of the disk offering'}, {u'name': u'bytesreadrate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'bytes read rate of the disk offering'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 4096, u'type': u'string', u'description': u'alternate display text of the disk offering'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'tags for the disk offering'}, {u'name': u'displayoffering', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'an optional field, whether to display the offering to the end user or not.'}, {u'name': u'maxiops', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'max iops of the disk offering'}, {u'name': u'byteswriterate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'bytes write rate of the disk offering'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the disk offering'}], u'requiredparams': [u'displaytext', u'name'], u'description': u'Creates a disk offering.'}, u'securitygroup': {u'name': u'createSecurityGroup', u'related': [u'listSecurityGroups'], u'isasync': False, u'params': [{u'name': u'description', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the description of the security group'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the security group. Must be used with domainId.'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the security group'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the security group. If the account parameter is used, domainId must also be used.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'Create security group for project'}], u'requiredparams': [u'name'], u'description': u'Creates a security group'}, u'portforwardingrule': {u'name': u'createPortForwardingRule', u'related': [u'listIpForwardingRules'], u'isasync': True, u'params': [{u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list to forward traffic from'}, {u'name': u'openfirewall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true'}, {u'name': u'publicport', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u"the starting port of port forwarding rule's public port range"}, {u'name': u'protocol', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the protocol for the port fowarding rule. Valid values are TCP or UDP.'}, {u'name': u'privateport', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u"the starting port of port forwarding rule's private port range"}, {u'name': u'vmguestip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'VM guest nic Secondary ip address for the port forwarding rule'}, {u'name': u'ipaddressid', u'required': True, u'related': [u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the IP address id of the port forwarding rule'}, {u'name': u'privateendport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u"the ending port of port forwarding rule's private port range"}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'The network of the vm the Port Forwarding rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)'}, {u'name': u'publicendport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u"the ending port of port forwarding rule's private port range"}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine for the port forwarding rule'}], u'requiredparams': [u'publicport', u'protocol', u'privateport', u'ipaddressid', u'virtualmachineid'], u'description': u'Creates a port forwarding rule'}, u'pod': {u'name': u'createPod', u'related': [u'updatePod'], u'isasync': False, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the Pod'}, {u'name': u'netmask', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask for the Pod'}, {u'name': u'startip', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the starting IP address for the Pod'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this Pod for allocation of new resources'}, {u'name': u'zoneid', u'required': True, u'related': [u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID in which the Pod will be created'}, {u'name': u'endip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IP address for the Pod'}, {u'name': u'gateway', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway for the Pod'}], u'requiredparams': [u'name', u'netmask', u'startip', u'zoneid', u'gateway'], u'description': u'Creates a new Pod.'}, u'ipforwardingrule': {u'name': u'createIpForwardingRule', u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'updatePortForwardingRule'], u'isasync': True, u'params': [{u'name': u'openfirewall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default'}, {u'name': u'protocol', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the protocol for the rule. Valid values are TCP or UDP.'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list to forward traffic from'}, {u'name': u'ipaddressid', u'required': True, u'related': [u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the public IP address id of the forwarding rule, already associated via associateIp'}, {u'name': u'endport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the end port for the rule'}, {u'name': u'startport', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the start port for the rule'}], u'requiredparams': [u'protocol', u'ipaddressid', u'startport'], u'description': u'Creates an ip forwarding rule'}, u'secondarystagingstore': {u'name': u'createSecondaryStagingStore', u'related': [u'listSwifts'], u'isasync': False, u'params': [{u'name': u'scope', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the scope of the staging store: zone only for now'}, {u'name': u'provider', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the staging store provider name'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL for the staging store'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the staging store'}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'the details for the staging store'}], u'requiredparams': [u'url'], u'description': u'create secondary staging store.'}, u'lbstickinesspolicy': {u'name': u'createLBStickinessPolicy', u'related': [], u'isasync': True, u'params': [{u'name': u'lbruleid', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'description', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the description of the LB Stickiness policy'}, {u'name': u'param', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'param list. Example: param[0].name=cookiename&param[0].value=LBCookie '}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the LB Stickiness policy'}, {u'name': u'methodname', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the LB Stickiness policy method, possible values can be obtained from ListNetworks API '}], u'requiredparams': [u'lbruleid', u'name', u'methodname'], u'description': u'Creates a Load Balancer stickiness policy '}, u'vpcoffering': {u'name': u'createVPCOffering', u'related': [u'listVPCOfferings'], u'isasync': True, u'params': [{u'name': u'displaytext', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the vpc offering'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the vpc offering'}, {u'name': u'supportedservices', u'required': True, u'related': [], u'length': 255, u'type': u'list', u'description': u'services supported by the vpc offering'}, {u'name': u'serviceproviderlist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network'}], u'requiredparams': [u'displaytext', u'name', u'supportedservices'], u'description': u'Creates VPC offering'}, u'network': {u'name': u'createNetwork', u'related': [u'updateNetwork', u'listNetworks'], u'isasync': False, u'params': [{u'name': u'aclid', u'required': False, u'related': [u'createNetworkACLList', u'listNetworkACLLists'], u'length': 255, u'type': u'uuid', u'description': u'Network ACL Id associated for the network'}, {u'name': u'endipv6', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IPv6 address in the IPv6 network range'}, {u'name': u'gateway', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway of the network. Required for Shared networks and Isolated networks when it belongs to VPC'}, {u'name': u'displaynetwork', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'an optional field, whether to the display the network to the end user or not.'}, {u'name': u'startip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the beginning IP address in the network IP range'}, {u'name': u'ip6cidr', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the CIDR of IPv6 network, must be at least /64'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'domain ID of the account owning a network'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the network'}, {u'name': u'isolatedpvlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the isolated private vlan for this network'}, {u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID the network belongs to'}, {u'name': u'networkdomain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'network domain'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ID or VID of the network'}, {u'name': u'subdomainaccess', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the network'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'an optional project for the ssh key'}, {u'name': u'startipv6', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the beginning IPv6 address in the IPv6 network range'}, {u'name': u'netmask', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask of the network. Required for Shared networks and Isolated networks when it belongs to VPC'}, {u'name': u'vpcid', u'required': False, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'the VPC network belongs to'}, {u'name': u'networkofferingid', u'required': True, u'related': [u'updateNetworkOffering', u'createNetworkOffering'], u'length': 255, u'type': u'uuid', u'description': u'the network offering id'}, {u'name': u'endip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IP address in the network IP range. If not specified, will be defaulted to startIP'}, {u'name': u'acltype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all Isolated networks - Account. Account means that only the account owner can use the network, domain - all accouns in the domain can use the network'}, {u'name': u'ip6gateway', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'account who will own the network'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the network'}], u'requiredparams': [u'name', u'zoneid', u'networkofferingid', u'displaytext'], u'description': u'Creates a network'}, u'zone': {u'name': u'createZone', u'related': [u'listZones'], u'isasync': False, u'params': [{u'name': u'dns1', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the first DNS for the Zone'}, {u'name': u'securitygroupenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if network is security group enabled, false otherwise'}, {u'name': u'guestcidraddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the guest CIDR address for the Zone'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the containing domain, null for public zones'}, {u'name': u'domain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Network domain name for the networks in the zone'}, {u'name': u'ip6dns1', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the first DNS for IPv6 network in the Zone'}, {u'name': u'dns2', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the second DNS for the Zone'}, {u'name': u'ip6dns2', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the second DNS for IPv6 network in the Zone'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this Zone for allocation of new resources'}, {u'name': u'internaldns1', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the first internal DNS for the Zone'}, {u'name': u'internaldns2', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the second internal DNS for the Zone'}, {u'name': u'localstorageenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if local storage offering enabled, false otherwise'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the Zone'}, {u'name': u'networktype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'network type of the zone, can be Basic or Advanced'}], u'requiredparams': [u'dns1', u'internaldns1', u'name', u'networktype'], u'description': u'Creates a Zone.'}, u'remoteaccessvpn': {u'name': u'createRemoteAccessVpn', u'related': [], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the VPN. Must be used with domainId.'}, {u'name': u'openfirewall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default'}, {u'name': u'publicipid', u'required': True, u'related': [u'associateIpAddress'], u'length': 255, u'type': u'uuid', u'description': u'public ip address id of the vpn server'}, {u'name': u'iprange', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the VPN. If the account parameter is used, domainId must also be used.'}], u'requiredparams': [u'publicipid'], u'description': u'Creates a l2tp/ipsec remote access vpn'}, u'instancegroup': {u'name': u'createInstanceGroup', u'related': [u'updateInstanceGroup'], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID of account owning the instance group'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account of the instance group. The account parameter must be used with the domainId parameter.'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the instance group'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'The project of the instance group'}], u'requiredparams': [u'name'], u'description': u'Creates a vm group'}, u'autoscalepolicy': {u'name': u'createAutoScalePolicy', u'related': [], u'isasync': True, u'params': [{u'name': u'duration', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the duration for which the conditions have to be true before action is taken'}, {u'name': u'action', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the action to be executed if all the conditions evaluate to true for the specified duration.'}, {u'name': u'quiettime', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the cool down period for which the policy should not be evaluated after the action has been taken'}, {u'name': u'conditionids', u'required': True, u'related': [], u'length': 255, u'type': u'list', u'description': u'the list of IDs of the conditions that are being evaluated on every interval'}], u'requiredparams': [u'duration', u'action', u'conditionids'], u'description': u'Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.'}, u'globalloadbalancerrule': {u'name': u'createGlobalLoadBalancerRule', u'related': [u'listGlobalLoadBalancerRules', u'updateGlobalLoadBalancerRule'], u'isasync': True, u'params': [{u'name': u'gslblbmethod', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'"}, {u'name': u'gslbservicetype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'GSLB service type (tcp, udp)'}, {u'name': u'regionid', u'required': True, u'related': [u'addRegion', u'listRegions'], u'length': 255, u'type': u'integer', u'description': u'region where the global load balancer is going to be created.'}, {u'name': u'description', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the description of the load balancer rule'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account associated with the global load balancer. Must be used with the domainId parameter.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID associated with the load balancer'}, {u'name': u'gslbstickysessionmethodname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'session sticky method (sourceip) if not specified defaults to sourceip'}, {u'name': u'gslbdomainname', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'domain name for the GSLB service.'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the load balancer rule'}], u'requiredparams': [u'gslbservicetype', u'regionid', u'gslbdomainname', u'name'], u'description': u'Creates a global load balancer rule'}, u'portableiprange': {u'name': u'createPortableIpRange', u'related': [u'listPortableIpRanges'], u'isasync': True, u'params': [{u'name': u'gateway', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway for the portable IP range'}, {u'name': u'endip', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IP address in the portable IP range'}, {u'name': u'regionid', u'required': True, u'related': [u'updateRegion', u'addRegion', u'listRegions'], u'length': 255, u'type': u'integer', u'description': u'Id of the Region'}, {u'name': u'startip', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the beginning IP address in the portable IP range'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'VLAN id, if not specified defaulted to untagged'}, {u'name': u'netmask', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask of the portable IP range'}], u'requiredparams': [u'gateway', u'endip', u'regionid', u'startip', u'netmask'], u'description': u"adds a range of portable public IP's to a region"}, u'serviceoffering': {u'name': u'createServiceOffering', u'related': [u'listServiceOfferings'], u'isasync': False, u'params': [{u'name': u'serviceofferingdetails', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'details for planner, used to store specific parameters'}, {u'name': u'iopsreadrate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'io requests read rate of the disk offering'}, {u'name': u'issystem', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'is this a system vm offering'}, {u'name': u'byteswriterate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'bytes write rate of the disk offering'}, {u'name': u'networkrate', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype'}, {u'name': u'hosttags', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the host tag for this service offering.'}, {u'name': u'cpunumber', u'required': True, u'related': [], u'length': 255, u'type': u'long', u'description': u'the CPU number of the service offering'}, {u'name': u'cpuspeed', u'required': True, u'related': [], u'length': 255, u'type': u'long', u'description': u'the CPU speed of the service offering in MHz.'}, {u'name': u'isvolatile', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM'}, {u'name': u'deploymentplanner', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the containing domain, null for public offerings'}, {u'name': u'offerha', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'the HA for the service offering'}, {u'name': u'memory', u'required': True, u'related': [], u'length': 255, u'type': u'long', u'description': u'the total memory of the service offering in MB'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the service offering'}, {u'name': u'storagetype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the storage type of the service offering. Values are local and shared.'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the service offering'}, {u'name': u'systemvmtype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".'}, {u'name': u'bytesreadrate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'bytes read rate of the disk offering'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the tags for this service offering.'}, {u'name': u'limitcpuuse', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'restrict the CPU usage to committed service offering'}, {u'name': u'iopswriterate', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'io requests write rate of the disk offering'}], u'requiredparams': [u'cpunumber', u'cpuspeed', u'memory', u'name', u'displaytext'], u'description': u'Creates a service offering.'}, u'template': {u'name': u'createTemplate', u'related': [u'updateTemplate', u'registerTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'isasync': True, u'params': [{u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'Template details in key/value pairs.'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'listLoadBalancerRuleInstances', u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the display text of the template. This is usually used for display purposes.'}, {u'name': u'isfeatured', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if this template is a featured template, false otherwise'}, {u'name': u'bits', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'32 or 64 bit'}, {u'name': u'requireshvm', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template requres HVM, false otherwise'}, {u'name': u'ispublic', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if this template is a public template, false otherwise'}, {u'name': u'url', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server'}, {u'name': u'snapshotid', u'required': False, u'related': [u'createSnapshot', u'listSnapshots'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in'}, {u'name': u'ostypeid', u'required': True, u'related': [u'listOsTypes'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the OS Type that best represents the OS of this template.'}, {u'name': u'isdynamicallyscalable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the template'}, {u'name': u'templatetag', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the tag for this template.'}, {u'name': u'passwordenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template supports the password reset feature; default is false'}, {u'name': u'volumeid', u'required': False, u'related': [u'detachVolume', u'createVolume', u'migrateVolume', u'updateVolume', u'attachVolume', u'resizeVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in'}], u'requiredparams': [u'displaytext', u'ostypeid', u'name'], u'description': u'Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.'}, u'vpngateway': {u'name': u'createVpnGateway', u'related': [], u'isasync': True, u'params': [{u'name': u'vpcid', u'required': True, u'related': [u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'public ip address id of the vpn gateway'}], u'requiredparams': [u'vpcid'], u'description': u'Creates site to site vpn local gateway'}, u'networkacllist': {u'name': u'createNetworkACLList', u'related': [], u'isasync': True, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of the network ACL List'}, {u'name': u'vpcid', u'required': True, u'related': [u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'Id of the VPC associated with this network ACL List'}, {u'name': u'description', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Description of the network ACL List'}], u'requiredparams': [u'name', u'vpcid'], u'description': u'Creates a Network ACL for the given VPC'}, u'autoscalevmgroup': {u'name': u'createAutoScaleVmGroup', u'related': [u'disableAutoScaleVmGroup', u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'isasync': True, u'params': [{u'name': u'scaleuppolicyids', u'required': True, u'related': [u'updateAutoScalePolicy', u'createAutoScalePolicy'], u'length': 255, u'type': u'list', u'description': u'list of scaleup autoscale policies'}, {u'name': u'scaledownpolicyids', u'required': True, u'related': [u'updateAutoScalePolicy', u'createAutoScalePolicy'], u'length': 255, u'type': u'list', u'description': u'list of scaledown autoscale policies'}, {u'name': u'interval', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the frequency at which the conditions have to be evaluated'}, {u'name': u'lbruleid', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'vmprofileid', u'required': True, u'related': [u'listAutoScaleVmProfiles'], u'length': 255, u'type': u'uuid', u'description': u'the autoscale profile that contains information about the vms in the vm group.'}, {u'name': u'maxmembers', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.'}, {u'name': u'minmembers', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.'}], u'requiredparams': [u'scaleuppolicyids', u'scaledownpolicyids', u'lbruleid', u'vmprofileid', u'maxmembers', u'minmembers'], u'description': u'Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.'}, u'vpnconnection': {u'name': u'createVpnConnection', u'related': [u'listVpnConnections', u'resetVpnConnection'], u'isasync': True, u'params': [{u'name': u's2scustomergatewayid', u'required': True, u'related': [u'createVpnCustomerGateway', u'listVpnCustomerGateways', u'updateVpnCustomerGateway'], u'length': 255, u'type': u'uuid', u'description': u'id of the customer gateway'}, {u'name': u's2svpngatewayid', u'required': True, u'related': [u'listVpnGateways', u'createVpnGateway'], u'length': 255, u'type': u'uuid', u'description': u'id of the vpn gateway'}], u'requiredparams': [u's2scustomergatewayid', u's2svpngatewayid'], u'description': u'Create site to site vpn connection'}, u'networkacl': {u'name': u'createNetworkACL', u'related': [], u'isasync': True, u'params': [{u'name': u'action', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'scl entry action, allow or deny'}, {u'name': u'icmptype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'type of the icmp message being sent'}, {u'name': u'aclid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The network of the vm the ACL will be created for'}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'The network of the vm the ACL will be created for'}, {u'name': u'endport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the ending port of ACL'}, {u'name': u'icmpcode', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'error code for this icmp message'}, {u'name': u'number', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'The network of the vm the ACL will be created for'}, {u'name': u'startport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the starting port of ACL'}, {u'name': u'protocol', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number'}, {u'name': u'traffictype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the traffic type for the ACL,can be Ingress or Egress, defaulted to Ingress if not specified'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list to allow traffic from/to'}], u'requiredparams': [u'protocol'], u'description': u'Creates a ACL rule in the given network (the network has to belong to VPC)'}, u'storagepool': {u'name': u'createStoragePool', u'related': [u'findStoragePoolsForMigration', u'listStoragePools'], u'isasync': False, u'params': [{u'name': u'podid', u'required': False, u'related': [u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID for the storage pool'}, {u'name': u'clusterid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the cluster ID for the storage pool'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the tags for the storage pool'}, {u'name': u'managed', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'whether the storage should be managed by CloudStack'}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.'}, {u'name': u'capacityiops', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'IOPS CloudStack can provision from this storage pool'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name for the storage pool'}, {u'name': u'scope', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the scope of the storage: cluster or zone'}, {u'name': u'provider', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the storage provider name'}, {u'name': u'zoneid', u'required': True, u'related': [u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the storage pool'}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'the details for the storage pool'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL of the storage pool'}, {u'name': u'capacitybytes', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'bytes CloudStack can provision from this storage pool'}], u'requiredparams': [u'name', u'zoneid', u'url'], u'description': u'Creates a storage pool.'}, u'vmsnapshot': {u'name': u'createVMSnapshot', u'related': [u'listVMSnapshot'], u'isasync': True, u'params': [{u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the vm'}, {u'name': u'snapshotmemory', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'snapshot memory if true'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The display name of the snapshot'}, {u'name': u'description', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The discription of the snapshot'}], u'requiredparams': [u'virtualmachineid'], u'description': u'Creates snapshot for a vm.'}, u'tags': {u'name': u'createTags', u'related': [], u'isasync': True, u'params': [{u'name': u'tags', u'required': True, u'related': [], u'length': 255, u'type': u'map', u'description': u'Map of tags (key/value pairs)'}, {u'name': u'resourcetype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of the resource'}, {u'name': u'customer', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally"}, {u'name': u'resourceids', u'required': True, u'related': [], u'length': 255, u'type': u'list', u'description': u'list of resources to create the tags for'}], u'requiredparams': [u'tags', u'resourcetype', u'resourceids'], u'description': u'Creates resource tag(s)'}, u'staticroute': {u'name': u'createStaticRoute', u'related': [u'listStaticRoutes'], u'isasync': True, u'params': [{u'name': u'cidr', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'static route cidr'}, {u'name': u'gatewayid', u'required': True, u'related': [u'createPrivateGateway'], u'length': 255, u'type': u'uuid', u'description': u'the gateway id we are creating static route for'}], u'requiredparams': [u'cidr', u'gatewayid'], u'description': u'Creates a static route'}, u'volume': {u'name': u'createVolume', u'related': [u'uploadVolume'], u'isasync': True, u'params': [{u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'the project associated with the volume. Mutually exclusive with account parameter'}, {u'name': u'maxiops', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'max iops'}, {u'name': u'diskofferingid', u'required': False, u'related': [u'createDiskOffering'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.'}, {u'name': u'displayvolume', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'an optional field, whether to display the volume to the end user or not.'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the disk volume'}, {u'name': u'snapshotid', u'required': False, u'related': [u'createSnapshot'], u'length': 255, u'type': u'uuid', u'description': u'the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.'}, {u'name': u'miniops', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'min iops'}, {u'name': u'size', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'Arbitrary volume size'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account associated with the disk volume. Must be used with the domainId parameter.'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the availability zone'}], u'requiredparams': [u'name'], u'description': u'Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.'}, u'user': {u'name': u'createUser', u'related': [u'listUsers', u'updateUser', u'lockUser', u'getUser', u'disableUser'], u'isasync': False, u'params': [{u'name': u'firstname', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'firstname'}, {u'name': u'email', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'email'}, {u'name': u'userid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'User UUID, required for adding account from external provisioning system'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.'}, {u'name': u'lastname', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'lastname'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Unique username.'}, {u'name': u'timezone', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.'}, {u'name': u'account', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Creates the user under the specified account. If no account is specified, the username will be used as the account name.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'Creates the user under the specified domain. Has to be accompanied with the account parameter'}], u'requiredparams': [u'firstname', u'email', u'password', u'lastname', u'username', u'account'], u'description': u'Creates a user for an account that already exists'}, u'vpc': {u'name': u'createVPC', u'related': [u'restartVPC', u'listVPCs'], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account associated with the VPC. Must be used with the domainId parameter.'}, {u'name': u'zoneid', u'required': True, u'related': [u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the availability zone'}, {u'name': u'cidr', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u"the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR"}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the VPC'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.'}, {u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'create VPC for the project'}, {u'name': u'vpcofferingid', u'required': True, u'related': [u'listVPCOfferings'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the VPC offering'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the VPC'}, {u'name': u'networkdomain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'VPC network domain. All networks inside the VPC will belong to this domain'}], u'requiredparams': [u'zoneid', u'cidr', u'displaytext', u'vpcofferingid', u'name'], u'description': u'Creates a VPC'}, u'storagenetworkiprange': {u'name': u'createStorageNetworkIpRange', u'related': [u'listStorageNetworkIpRange', u'updateStorageNetworkIpRange'], u'isasync': True, u'params': [{u'name': u'gateway', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway for storage network'}, {u'name': u'podid', u'required': True, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'UUID of pod where the ip range belongs to'}, {u'name': u'startip', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the beginning IP address'}, {u'name': u'endip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IP address'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Optional. The vlan the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly reterive bridge from pyhsical network traffic type table'}, {u'name': u'netmask', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask for storage network'}], u'requiredparams': [u'gateway', u'podid', u'startip', u'netmask'], u'description': u'Creates a Storage network IP range.'}, u'condition': {u'name': u'createCondition', u'related': [u'listConditions'], u'isasync': True, u'params': [{u'name': u'counterid', u'required': True, u'related': [u'listCounters', u'createCounter'], u'length': 255, u'type': u'uuid', u'description': u'ID of the Counter.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID of the account.'}, {u'name': u'relationaloperator', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Relational Operator to be used with threshold.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account of the condition. Must be used with the domainId parameter.'}, {u'name': u'threshold', u'required': True, u'related': [], u'length': 255, u'type': u'long', u'description': u'Threshold value.'}], u'requiredparams': [u'counterid', u'relationaloperator', u'threshold'], u'description': u'Creates a condition'}, u'autoscalevmprofile': {u'name': u'createAutoScaleVmProfile', u'related': [u'updateAutoScaleVmProfile', u'listAutoScaleVmProfiles'], u'isasync': True, u'params': [{u'name': u'otherdeployparams', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'availability zone for the auto deployed virtual machine'}, {u'name': u'autoscaleuserid', u'required': False, u'related': [u'createUser', u'listUsers', u'updateUser', u'lockUser', u'getUser', u'disableUser', u'enableUser'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the user used to launch and destroy the VMs'}, {u'name': u'destroyvmgraceperiod', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the time allowed for existing connections to get closed before a vm is destroyed'}, {u'name': u'serviceofferingid', u'required': True, u'related': [u'updateServiceOffering', u'listServiceOfferings', u'createServiceOffering'], u'length': 255, u'type': u'uuid', u'description': u'the service offering of the auto deployed virtual machine'}, {u'name': u'templateid', u'required': True, u'related': [u'updateTemplate', u'registerTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the template of the auto deployed virtual machine'}, {u'name': u'counterparam', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161'}], u'requiredparams': [u'zoneid', u'serviceofferingid', u'templateid'], u'description': u'Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.'}, u'affinitygroup': {u'name': u'createAffinityGroup', u'related': [u'listAffinityGroups'], u'isasync': True, u'params': [{u'name': u'type', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Type of the affinity group from the available affinity/anti-affinity group types'}, {u'name': u'description', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'optional description of the affinity group'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'domainId of the account owning the affinity group'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the affinity group'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an account for the affinity group. Must be used with domainId.'}], u'requiredparams': [u'type', u'name'], u'description': u'Creates an affinity/anti-affinity group'}, u'account': {u'name': u'createAccount', u'related': [u'listAccounts', u'disableAccount', u'markDefaultZoneForAccount'], u'isasync': False, u'params': [{u'name': u'timezone', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.'}, {u'name': u'email', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'email'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.'}, {u'name': u'accounttype', u'required': True, u'related': [], u'length': 255, u'type': u'short', u'description': u'Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin'}, {u'name': u'accountid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Account UUID, required for adding account from external provisioning system'}, {u'name': u'networkdomain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"Network domain for the account's networks"}, {u'name': u'userid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'User UUID, required for adding account from external provisioning system'}, {u'name': u'accountdetails', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'details for account used to store specific parameters'}, {u'name': u'firstname', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'firstname'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Unique username.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'Creates the user under the specified domain.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Creates the user under the specified account. If no account is specified, the username will be used as the account name.'}, {u'name': u'lastname', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'lastname'}], u'requiredparams': [u'email', u'password', u'accounttype', u'firstname', u'username', u'lastname'], u'description': u'Creates an account'}, u'firewallrule': {u'name': u'createFirewallRule', u'related': [u'listEgressFirewallRules'], u'isasync': True, u'params': [{u'name': u'icmptype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'type of the icmp message being sent'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list to forward traffic from'}, {u'name': u'ipaddressid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the IP address id of the port forwarding rule'}, {u'name': u'startport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the starting port of firewall rule'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of firewallrule: system/user'}, {u'name': u'icmpcode', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'error code for this icmp message'}, {u'name': u'protocol', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.'}, {u'name': u'endport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the ending port of firewall rule'}], u'requiredparams': [u'ipaddressid', u'protocol'], u'description': u'Creates a firewall rule for a given ip address'}, u'networkoffering': {u'name': u'createNetworkOffering', u'related': [u'updateNetworkOffering'], u'isasync': False, u'params': [{u'name': u'traffictype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the traffic type for the network offering. Supported type in current release is GUEST only'}, {u'name': u'serviceofferingid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the service offering ID used by virtual router provider'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the network offering'}, {u'name': u'maxconnections', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'maximum number of concurrent connections supported by the network offering'}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value'}, {u'name': u'guestiptype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'guest type of the network offering: Shared or Isolated'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the network offering'}, {u'name': u'specifyvlan', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if network offering supports vlans'}, {u'name': u'servicecapabilitylist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'desired service capabilities as part of network offering'}, {u'name': u'serviceproviderlist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network'}, {u'name': u'availability', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the availability of network offering. Default value is Optional'}, {u'name': u'ispersistent', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if network offering supports persistent networks; defaulted to false if not specified'}, {u'name': u'conservemode', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the network offering is IP conserve mode enabled'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the tags for the network offering.'}, {u'name': u'supportedservices', u'required': True, u'related': [], u'length': 255, u'type': u'list', u'description': u'services supported by the network offering'}, {u'name': u'specifyipranges', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if network offering supports specifying ip ranges; defaulted to false if not specified'}, {u'name': u'egressdefaultpolicy', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if default guest network egress policy is allow; false if default egress policy is deny'}, {u'name': u'networkrate', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'data transfer rate in megabits per second allowed'}], u'requiredparams': [u'traffictype', u'displaytext', u'guestiptype', u'name', u'supportedservices'], u'description': u'Creates a network offering.'}, u'vlaniprange': {u'name': u'createVlanIpRange', u'related': [u'listVlanIpRanges', u'dedicatePublicIpRange'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited'}, {u'name': u'podid', u'required': False, u'related': [u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'optional parameter. Have to be specified for Direct Untagged vlan only.'}, {u'name': u'endip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IP address in the VLAN IP range'}, {u'name': u'startipv6', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the beginning IPv6 address in the IPv6 network range'}, {u'name': u'ip6gateway', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC'}, {u'name': u'forvirtualnetwork', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if VLAN is of Virtual type, false if Direct'}, {u'name': u'ip6cidr', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the CIDR of IPv6 network, must be at least /64'}, {u'name': u'endipv6', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IPv6 address in the IPv6 network range'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID of the VLAN IP range'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'domain ID of the account owning a VLAN'}, {u'name': u'netmask', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask of the VLAN IP range'}, {u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the physical network id'}, {u'name': u'startip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the beginning IP address in the VLAN IP range'}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the network id'}, {u'name': u'gateway', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway of the VLAN IP range'}], u'requiredparams': [], u'description': u'Creates a VLAN IP range.'}, u'internalloadbalancerelement': {u'name': u'createInternalLoadBalancerElement', u'related': [u'configureInternalLoadBalancerElement'], u'isasync': True, u'params': [{u'name': u'nspid', u'required': True, u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider', u'listTrafficTypes'], u'length': 255, u'type': u'uuid', u'description': u'the network service provider ID of the internal load balancer element'}], u'requiredparams': [u'nspid'], u'description': u'Create an Internal Load Balancer element.'}, u'counter': {u'name': u'createCounter', u'related': [], u'isasync': True, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of the counter.'}, {u'name': u'value', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Value of the counter e.g. oid in case of snmp.'}, {u'name': u'source', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Source of the counter.'}], u'requiredparams': [u'name', u'value', u'source'], u'description': u'Adds metric counter'}, u'lbhealthcheckpolicy': {u'name': u'createLBHealthCheckPolicy', u'related': [], u'isasync': True, u'params': [{u'name': u'pingpath', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'HTTP Ping Path'}, {u'name': u'unhealthythreshold', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Number of consecutive health check failures before declaring an instance unhealthy'}, {u'name': u'intervaltime', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Amount of time between health checks (1 sec - 20940 sec)'}, {u'name': u'lbruleid', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'responsetimeout', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Time to wait when receiving a response from the health check (2sec - 60 sec)'}, {u'name': u'description', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the description of the load balancer HealthCheck policy'}, {u'name': u'healthythreshold', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Number of consecutive health check success before declaring an instance healthy'}], u'requiredparams': [u'lbruleid'], u'description': u'Creates a Load Balancer healthcheck policy '}, u'project': {u'name': u'createProject', u'related': [], u'isasync': True, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'domain ID of the account owning a project'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'account who will be Admin for the project'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the project'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'display text of the project'}], u'requiredparams': [u'name', u'displaytext'], u'description': u'Creates a project'}, u'vpncustomergateway': {u'name': u'createVpnCustomerGateway', u'related': [u'listVpnCustomerGateways', u'updateVpnCustomerGateway'], u'isasync': True, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.'}, {u'name': u'dpd', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'If DPD is enabled for VPN connection'}, {u'name': u'ipsecpsk', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'IPsec Preshared-Key of the customer gateway'}, {u'name': u'gateway', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'public ip address id of the customer gateway'}, {u'name': u'esppolicy', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'ESP policy of the customer gateway'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account associated with the gateway. Must be used with the domainId parameter.'}, {u'name': u'ikelifetime', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'Lifetime of phase 1 VPN connection to the customer gateway, in seconds'}, {u'name': u'ikepolicy', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'IKE policy of the customer gateway'}, {u'name': u'esplifetime', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'Lifetime of phase 2 VPN connection to the customer gateway, in seconds'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of this customer gateway'}, {u'name': u'cidrlist', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'guest cidr list of the customer gateway'}], u'requiredparams': [u'ipsecpsk', u'gateway', u'esppolicy', u'ikepolicy', u'cidrlist'], u'description': u'Creates site to site vpn customer gateway'}, u'snapshot': {u'name': u'createSnapshot', u'related': [], u'isasync': True, u'params': [{u'name': u'policyid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'policy id of the snapshot, if this is null, then use MANUAL_POLICY.'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The account of the snapshot. The account parameter must be used with the domainId parameter.'}, {u'name': u'volumeid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The ID of the disk volume'}], u'requiredparams': [u'volumeid'], u'description': u'Creates an instant snapshot of a volume.'}, u'loadbalancer': {u'name': u'createLoadBalancer', u'related': [], u'isasync': True, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the Load Balancer'}, {u'name': u'sourceipaddressnetworkid', u'required': True, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the network id of the source ip address'}, {u'name': u'networkid', u'required': True, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'The guest network the Load Balancer will be created for'}, {u'name': u'algorithm', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'load balancer algorithm (source, roundrobin, leastconn)'}, {u'name': u'sourceipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the source ip address the network traffic will be load balanced from'}, {u'name': u'scheme', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the load balancer scheme. Supported value in this release is Internal'}, {u'name': u'instanceport', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the TCP port of the virtual machine where the network traffic will be load balanced to'}, {u'name': u'sourceport', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the source port the network traffic will be load balanced from'}, {u'name': u'description', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the description of the Load Balancer'}], u'requiredparams': [u'name', u'sourceipaddressnetworkid', u'networkid', u'algorithm', u'scheme', u'instanceport', u'sourceport'], u'description': u'Creates a Load Balancer'}, u'virtualrouterelement': {u'name': u'createVirtualRouterElement', u'related': [u'configureVirtualRouterElement'], u'isasync': True, u'params': [{u'name': u'providertype', u'required': False, u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider'], u'length': 255, u'type': u'uuid', u'description': u'The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter'}, {u'name': u'nspid', u'required': True, u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider'], u'length': 255, u'type': u'uuid', u'description': u'the network service provider ID of the virtual router element'}], u'requiredparams': [u'nspid'], u'description': u'Create a virtual router element.'}, u'egressfirewallrule': {u'name': u'createEgressFirewallRule', u'related': [u'listFirewallRules', u'createFirewallRule', u'listEgressFirewallRules'], u'isasync': True, u'params': [{u'name': u'icmpcode', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'error code for this icmp message'}, {u'name': u'endport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the ending port of firewall rule'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of firewallrule: system/user'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list to forward traffic from'}, {u'name': u'icmptype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'type of the icmp message being sent'}, {u'name': u'networkid', u'required': True, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the network id of the port forwarding rule'}, {u'name': u'protocol', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.'}, {u'name': u'startport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the starting port of firewall rule'}], u'requiredparams': [u'networkid', u'protocol'], u'description': u'Creates a egress firewall rule for a given network '}, u'physicalnetwork': {u'name': u'createPhysicalNetwork', u'related': [u'listPhysicalNetworks'], u'isasync': True, u'params': [{u'name': u'broadcastdomainrange', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'Tag the physical network'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the physical network'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the VLAN for the physical network'}, {u'name': u'networkspeed', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the speed for the physical network[1G/10G]'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the physical network'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'domain ID of the account owning a physical network'}, {u'name': u'isolationmethods', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the isolation method for the physical network[VLAN/L3/GRE]'}], u'requiredparams': [u'name', u'zoneid'], u'description': u'Creates a physical network'}, u'sshkeypair': {u'name': u'createSSHKeyPair', u'related': [u'listSSHKeyPairs'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the ssh key. Must be used with domainId.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'an optional project for the ssh key'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of the keypair'}], u'requiredparams': [u'name'], u'description': u'Create a new keypair and returns the private key'}, u'privategateway': {u'name': u'createPrivateGateway', u'related': [], u'isasync': True, u'params': [{u'name': u'ipaddress', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the IP address of the Private gateaway'}, {u'name': u'vpcid', u'required': True, u'related': [u'restartVPC'], u'length': 255, u'type': u'uuid', u'description': u'the VPC network belongs to'}, {u'name': u'gateway', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway of the Private gateway'}, {u'name': u'sourcenatsupported', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u"source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported"}, {u'name': u'netmask', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask of the Private gateway'}, {u'name': u'physicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID the network belongs to'}, {u'name': u'aclid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network ACL'}, {u'name': u'vlan', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the Vlan for the private gateway'}], u'requiredparams': [u'ipaddress', u'vpcid', u'gateway', u'netmask', u'vlan'], u'description': u'Creates a private gateway'}}, u'deploy': {u'virtualmachine': {u'name': u'deployVirtualMachine', u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'keyboard', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us'}, {u'name': u'keypair', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the ssh key pair used to login to the virtual machine'}, {u'name': u'startvm', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if network offering supports specifying ip ranges; defaulted to true if not specified'}, {u'name': u'serviceofferingid', u'required': True, u'related': [u'listServiceOfferings', u'createServiceOffering'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the service offering for the virtual machine'}, {u'name': u'securitygroupids', u'required': False, u'related': [u'listSecurityGroups'], u'length': 255, u'type': u'list', u'description': u'comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter'}, {u'name': u'securitygroupnames', u'required': False, u'related': [u'listSecurityGroups'], u'length': 255, u'type': u'list', u'description': u'comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter'}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the hypervisor on which to deploy the virtual machine'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'availability zone for the virtual machine'}, {u'name': u'affinitygroupnames', u'required': False, u'related': [u'listAffinityGroups'], u'length': 255, u'type': u'list', u'description': u'comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter'}, {u'name': u'size', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId'}, {u'name': u'affinitygroupids', u'required': False, u'related': [u'listAffinityGroups'], u'length': 255, u'type': u'list', u'description': u'comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter'}, {u'name': u'ipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"the ip address for default vm's network"}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.'}, {u'name': u'userdata', u'required': False, u'related': [], u'length': 32768, u'type': u'string', u'description': u'an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 32K of data after base64 encoding.'}, {u'name': u'hostid', u'required': False, u'related': [u'addHost', u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'destination Host ID to deploy the VM to - parameter available for root admin only'}, {u'name': u'iptonetworklist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u"ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid - requests to use ip 10.10.10.11 in network id=uuid"}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the virtual machine. Must be used with domainId.'}, {u'name': u'displayvm', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'an optional field, whether to the display the vm to the end user or not.'}, {u'name': u'networkids', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'list', u'description': u"list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter"}, {u'name': u'diskofferingid', u'required': False, u'related': [u'listDiskOfferings', u'createDiskOffering'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.'}, {u'name': u'group', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional group for the virtual machine'}, {u'name': u'ip6address', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"the ipv6 address for default vm's network"}, {u'name': u'templateid', u'required': True, u'related': [u'updateTemplate', u'registerTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the template for the virtual machine'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'Deploy vm for the project'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'host name for the virtual machine'}, {u'name': u'displayname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional user generated name for the virtual machine'}], u'requiredparams': [u'serviceofferingid', u'zoneid', u'templateid'], u'description': u'Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.'}}, u'reboot': {u'systemvm': {u'name': u'rebootSystemVm', u'related': [u'scaleSystemVm'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'scaleSystemVm', u'rebootSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the system virtual machine'}], u'requiredparams': [u'id'], u'description': u'Reboots a system VM.'}, u'router': {u'name': u'rebootRouter', u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'rebootRouter'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the router'}], u'requiredparams': [u'id'], u'description': u'Starts a router.'}, u'virtualmachine': {u'name': u'rebootVirtualMachine', u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}], u'requiredparams': [u'id'], u'description': u'Reboots a virtual machine.'}}, u'find': {u'hostsformigration': {u'name': u'findHostsForMigration', u'related': [], u'isasync': False, u'params': [{u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'virtualmachineid'], u'description': u'Find hosts suitable for migrating a virtual machine.'}, u'storagepoolsformigration': {u'name': u'findStoragePoolsForMigration', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the volume'}, {u'name': u'page', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}, {u'name': u'keyword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'List by keyword'}, {u'name': u'pagesize', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': ''}], u'requiredparams': [u'id'], u'description': u'Lists storage pools available for migration of a volume.'}}, u'start': {u'systemvm': {u'name': u'startSystemVm', u'related': [u'changeServiceForSystemVm', u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'rebootSystemVm'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'changeServiceForSystemVm', u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'startSystemVm', u'rebootSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the system virtual machine'}], u'requiredparams': [u'id'], u'description': u'Starts a system virtual machine.'}, u'router': {u'name': u'startRouter', u'related': [u'listInternalLoadBalancerVMs'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'startRouter', u'listInternalLoadBalancerVMs'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the router'}], u'requiredparams': [u'id'], u'description': u'Starts a router.'}, u'internalloadbalancervm': {u'name': u'startInternalLoadBalancerVM', u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'rebootRouter', u'destroyRouter'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'startInternalLoadBalancerVM', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'rebootRouter', u'destroyRouter'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the internal lb vm'}], u'requiredparams': [u'id'], u'description': u'Starts an existing internal lb vm.'}, u'virtualmachine': {u'name': u'startVirtualMachine', u'related': [u'revertToVMSnapshot', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'revertToVMSnapshot', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}, {u'name': u'hostid', u'required': False, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'destination Host ID to deploy the VM to - parameter available for root admin only'}], u'requiredparams': [u'id'], u'description': u'Starts a virtual machine.'}}, u'add': {u'trafficmonitor': {u'name': u'addTrafficMonitor', u'related': [u'listTrafficMonitors'], u'isasync': False, u'params': [{u'name': u'excludezones', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Traffic going into the listed zones will not be metered'}, {u'name': u'includezones', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Traffic going into the listed zones will be metered'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'URL of the traffic monitor Host'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'Zone in which to add the external firewall appliance.'}], u'requiredparams': [u'url', u'zoneid'], u'description': u'Adds Traffic Monitor Host for Direct Network Usage'}, u'nictovirtualmachine': {u'name': u'addNicToVirtualMachine', u'related': [u'listLoadBalancerRuleInstances', u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'networkid', u'required': True, u'related': [u'createNetwork', u'updateNetwork', u'listNetworks'], u'length': 255, u'type': u'uuid', u'description': u'Network ID'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'listLoadBalancerRuleInstances', u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'addNicToVirtualMachine', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'Virtual Machine ID'}, {u'name': u'ipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'IP Address for the new network'}], u'requiredparams': [u'networkid', u'virtualmachineid'], u'description': u'Adds VM to specified network by creating a NIC'}, u'baremetalpxepingserver': {u'name': u'addBaremetalPxePingServer', u'related': [], u'isasync': True, u'params': [{u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'URL of the external pxe device'}, {u'name': u'pingdir', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Root directory on PING storage server'}, {u'name': u'physicalnetworkid', u'required': True, u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID'}, {u'name': u'podid', u'required': False, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'Pod Id'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Credentials to reach external pxe device'}, {u'name': u'pingstorageserverip', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'PING storage server ip'}, {u'name': u'pxeservertype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of pxe device'}, {u'name': u'pingcifspassword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Password of PING storage server'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Credentials to reach external pxe device'}, {u'name': u'tftpdir', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Tftp root directory of PXE server'}, {u'name': u'pingcifsusername', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Username of PING storage server'}], u'requiredparams': [u'url', u'pingdir', u'physicalnetworkid', u'username', u'pingstorageserverip', u'pxeservertype', u'password', u'tftpdir'], u'description': u'add a baremetal ping pxe server'}, u's3': {u'name': u'addS3', u'related': [u'listSecondaryStagingStores', u'listSwifts', u'createSecondaryStagingStore', u'addImageStore'], u'isasync': False, u'params': [{u'name': u'accesskey', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'S3 access key'}, {u'name': u'usehttps', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'connect to the S3 endpoint via HTTPS?'}, {u'name': u'sockettimeout', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'socket timeout (milliseconds)'}, {u'name': u'bucket', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the template storage bucket'}, {u'name': u'connectiontimeout', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'connection timeout (milliseconds)'}, {u'name': u'secretkey', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'S3 secret key'}, {u'name': u'endpoint', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'S3 host name'}, {u'name': u'maxerrorretry', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'maximum number of times to retry on error'}], u'requiredparams': [u'accesskey', u'bucket', u'secretkey'], u'description': u'Adds S3'}, u'accounttoproject': {u'name': u'addAccountToProject', u'related': [], u'isasync': True, u'params': [{u'name': u'projectid', u'required': True, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject', u'suspendProject'], u'length': 255, u'type': u'uuid', u'description': u'id of the project to add the account to'}, {u'name': u'email', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'email to which invitation to the project is going to be sent'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the account to be added to the project'}], u'requiredparams': [u'projectid'], u'description': u'Adds acoount to a project'}, u'region': {u'name': u'addRegion', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Id of the Region'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of the region'}, {u'name': u'endpoint', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Region service endpoint'}], u'requiredparams': [u'id', u'name', u'endpoint'], u'description': u'Adds a Region'}, u'secondarystorage': {u'name': u'addSecondaryStorage', u'related': [u'listSecondaryStagingStores', u'listImageStores', u'listSwifts', u'addS3', u'listS3s', u'createSecondaryStagingStore', u'addImageStore', u'addSwift'], u'isasync': False, u'params': [{u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the secondary storage'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL for the secondary storage'}], u'requiredparams': [u'url'], u'description': u'Adds secondary storage.'}, u'ucsmanager': {u'name': u'addUcsManager', u'related': [], u'isasync': False, u'params': [{u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username of UCS'}, {u'name': u'zoneid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Zone id for the ucs manager'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the password of UCS'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of UCS manager'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of UCS url'}], u'requiredparams': [u'username', u'zoneid', u'password', u'url'], u'description': u'Adds a Ucs manager'}, u'baremetalhost': {u'name': u'addBaremetalHost', u'related': [u'addHost', u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'isasync': False, u'params': [{u'name': u'ipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'ip address intentionally allocated to this host after provisioning'}, {u'name': u'podid', u'required': True, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID for the host'}, {u'name': u'hypervisor', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'hypervisor type of the host'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the password for the host'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the host'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the host URL'}, {u'name': u'hosttags', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list of tags to be added to the host'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username for the host'}, {u'name': u'clusterid', u'required': False, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the cluster ID for the host'}, {u'name': u'clustername', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the cluster name for the host'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this Host for allocation of new resources'}], u'requiredparams': [u'podid', u'hypervisor', u'password', u'zoneid', u'url', u'username'], u'description': u'add a baremetal host'}, u'traffictype': {u'name': u'addTrafficType', u'related': [], u'isasync': True, u'params': [{u'name': u'vmwarenetworklabel', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The network name label of the physical device dedicated to this traffic on a VMware host'}, {u'name': u'physicalnetworkid', u'required': True, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID'}, {u'name': u'traffictype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the trafficType to be added to the physical network'}, {u'name': u'kvmnetworklabel', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The network name label of the physical device dedicated to this traffic on a KVM host'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The VLAN id to be used for Management traffic by VMware host'}, {u'name': u'xennetworklabel', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The network name label of the physical device dedicated to this traffic on a XenServer host'}], u'requiredparams': [u'physicalnetworkid', u'traffictype'], u'description': u'Adds traffic type to a physical network'}, u'cluster': {u'name': u'addCluster', u'related': [u'listClusters', u'updateCluster'], u'isasync': False, u'params': [{u'name': u'vsmipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ipaddress of the VSM associated with this cluster'}, {u'name': u'guestvswitchtype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)'}, {u'name': u'publicvswitchtype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)'}, {u'name': u'username', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username for the cluster'}, {u'name': u'guestvswitchname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.'}, {u'name': u'publicvswitchname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.'}, {u'name': u'password', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the password for the host'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the cluster'}, {u'name': u'clustername', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the cluster name'}, {u'name': u'url', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL'}, {u'name': u'vsmpassword', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the password for the VSM associated with this cluster'}, {u'name': u'podid', u'required': True, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID for the host'}, {u'name': u'clustertype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of the cluster: CloudManaged, ExternalManaged'}, {u'name': u'vsmusername', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username for the VSM associated with this cluster'}, {u'name': u'hypervisor', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this cluster for allocation of new resources'}], u'requiredparams': [u'zoneid', u'clustername', u'podid', u'clustertype', u'hypervisor'], u'description': u'Adds a new cluster'}, u'host': {u'name': u'addHost', u'related': [u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'isasync': False, u'params': [{u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the password for the host'}, {u'name': u'podid', u'required': True, u'related': [u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the Pod ID for the host'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the host'}, {u'name': u'clusterid', u'required': False, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the cluster ID for the host'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the host URL'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this Host for allocation of new resources'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username for the host'}, {u'name': u'clustername', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the cluster name for the host'}, {u'name': u'hosttags', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list of tags to be added to the host'}, {u'name': u'hypervisor', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'hypervisor type of the host'}], u'requiredparams': [u'password', u'podid', u'zoneid', u'url', u'username', u'hypervisor'], u'description': u'Adds a new host.'}, u'vpnuser': {u'name': u'addVpnUser', u'related': [u'listVpnUsers'], u'isasync': True, u'params': [{u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'username for the vpn user'}, {u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'add vpn user to the specific project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the vpn user. Must be used with domainId.'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'password for the username'}], u'requiredparams': [u'username', u'password'], u'description': u'Adds vpn users'}, u'networkserviceprovider': {u'name': u'addNetworkServiceProvider', u'related': [u'updateNetworkServiceProvider'], u'isasync': True, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name for the physical network service provider'}, {u'name': u'servicelist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the list of services to be enabled for this physical network service provider'}, {u'name': u'physicalnetworkid', u'required': True, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID to add the provider to'}, {u'name': u'destinationphysicalnetworkid', u'required': False, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the destination Physical Network ID to bridge to'}], u'requiredparams': [u'name', u'physicalnetworkid'], u'description': u'Adds a network serviceProvider to a physical network'}, u'resourcedetail': {u'name': u'addResourceDetail', u'related': [], u'isasync': True, u'params': [{u'name': u'details', u'required': True, u'related': [], u'length': 255, u'type': u'map', u'description': u'Map of (key/value pairs)'}, {u'name': u'resourcetype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of the resource'}, {u'name': u'resourceid', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'resource id to create the details for'}], u'requiredparams': [u'details', u'resourcetype', u'resourceid'], u'description': u'Adds detail for the Resource.'}, u'imagestore': {u'name': u'addImageStore', u'related': [u'listSwifts', u'createSecondaryStagingStore'], u'isasync': False, u'params': [{u'name': u'url', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL for the image store'}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss'}, {u'name': u'provider', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the image store provider name'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name for the image store'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the Zone ID for the image store'}], u'requiredparams': [u'provider'], u'description': u'Adds backup image store.'}, u'baremetaldhcp': {u'name': u'addBaremetalDhcp', u'related': [], u'isasync': True, u'params': [{u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Credentials to reach external dhcp device'}, {u'name': u'dhcpservertype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Type of dhcp device'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'URL of the external dhcp appliance.'}, {u'name': u'physicalnetworkid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Credentials to reach external dhcp device'}], u'requiredparams': [u'password', u'dhcpservertype', u'url', u'physicalnetworkid', u'username'], u'description': u'adds a baremetal dhcp server'}, u'baremetalpxekickstartserver': {u'name': u'addBaremetalPxeKickStartServer', u'related': [], u'isasync': True, u'params': [{u'name': u'tftpdir', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Tftp root directory of PXE server'}, {u'name': u'podid', u'required': False, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'Pod Id'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Credentials to reach external pxe device'}, {u'name': u'pxeservertype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'type of pxe device'}, {u'name': u'physicalnetworkid', u'required': True, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'the Physical Network ID'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'URL of the external pxe device'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Credentials to reach external pxe device'}], u'requiredparams': [u'tftpdir', u'password', u'pxeservertype', u'physicalnetworkid', u'url', u'username'], u'description': u'add a baremetal pxe server'}, u'swift': {u'name': u'addSwift', u'related': [u'listSecondaryStagingStores', u'listSwifts', u'addS3', u'createSecondaryStagingStore', u'addImageStore'], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account for swift'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL for swift'}, {u'name': u'username', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username for swift'}, {u'name': u'key', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u' key for the user for swift'}], u'requiredparams': [u'url'], u'description': u'Adds Swift.'}, u'iptonic': {u'name': u'addIpToNic', u'related': [], u'isasync': True, u'params': [{u'name': u'ipaddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Secondary IP Address'}, {u'name': u'nicid', u'required': True, u'related': [u'listNics'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the nic to which you want to assign private IP'}], u'requiredparams': [u'nicid'], u'description': u'Assigns secondary IP to NIC'}, u'networkdevice': {u'name': u'addNetworkDevice', u'related': [u'listNetworkDevice'], u'isasync': False, u'params': [{u'name': u'networkdeviceparameterlist', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'parameters for network device'}, {u'name': u'networkdevicetype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall'}], u'requiredparams': [], u'description': u'Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer'}}, u'verbs': [u'authorize', u'restore', u'suspend', u'revoke', u'disassociate', u'migrate', u'lock', u'dedicate', u'activate', u'reconnect', u'cancel', u'query', u'recover', u'extract', u'archive', u'detach', u'prepare', u'start', u'revert', u'create', u'associate', u'reboot', u'find', u'attach', u'add', u'restart', u'deploy', u'ldap', u'destroy', u'enable', u'configure', u'get', u'stop', u'update', u'change', u'replace', u'disable', u'scale', u'copy', u'generate', u'resize', u'reset', u'register', u'list', u'upload', u'remove', u'mark', u'clean', u'release', u'assign', u'delete'], u'change': {u'serviceforvirtualmachine': {u'name': u'changeServiceForVirtualMachine', u'related': [u'revertToVMSnapshot', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}, {u'name': u'serviceofferingid', u'required': True, u'related': [u'listServiceOfferings'], u'length': 255, u'type': u'uuid', u'description': u'the service offering ID to apply to the virtual machine'}], u'requiredparams': [u'id', u'serviceofferingid'], u'description': u'Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.'}, u'serviceforsystemvm': {u'name': u'changeServiceForSystemVm', u'related': [u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'rebootSystemVm'], u'isasync': False, u'params': [{u'name': u'serviceofferingid', u'required': True, u'related': [u'listServiceOfferings', u'createServiceOffering'], u'length': 255, u'type': u'uuid', u'description': u'the service offering ID to apply to the system vm'}, {u'name': u'id', u'required': True, u'related': [u'changeServiceForSystemVm', u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'rebootSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the system vm'}], u'requiredparams': [u'serviceofferingid', u'id'], u'description': u'Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.'}, u'serviceforrouter': {u'name': u'changeServiceForRouter', u'related': [u'startRouter', u'listInternalLoadBalancerVMs'], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the router'}, {u'name': u'serviceofferingid', u'required': True, u'related': [u'listServiceOfferings', u'createServiceOffering'], u'length': 255, u'type': u'uuid', u'description': u'the service offering ID to apply to the domain router'}], u'requiredparams': [u'id', u'serviceofferingid'], u'description': u'Upgrades domain router to a new service offering'}}, u'ldap': {u'config': {u'name': u'ldapConfig', u'related': [u'ldapRemove'], u'isasync': False, u'params': [{u'name': u'listall', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'If true return current LDAP configuration'}, {u'name': u'truststore', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Enter the path to trust certificates store.'}, {u'name': u'ssl', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Check Use SSL if the external LDAP server is configured for LDAP over SSL.'}, {u'name': u'searchbase', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.'}, {u'name': u'binddn', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Specify the distinguished name of a user with the search permission on the directory.'}, {u'name': u'queryfilter', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'You specify a query filter here, which narrows down the users, who can be part of this domain.'}, {u'name': u'hostname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Hostname or ip address of the ldap server eg: my.ldap.com'}, {u'name': u'truststorepass', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Enter the password for trust store.'}, {u'name': u'port', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Specify the LDAP port if required, default is 389.'}, {u'name': u'bindpass', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Enter the password.'}], u'requiredparams': [], u'description': u'Configure the LDAP context for this site.'}, u'remove': {u'name': u'ldapRemove', u'related': [], u'isasync': False, u'params': [], u'requiredparams': [], u'description': u'Remove the LDAP context for this site.'}}, u'destroy': {u'systemvm': {u'name': u'destroySystemVm', u'related': [u'stopSystemVm', u'changeServiceForSystemVm', u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'startSystemVm', u'rebootSystemVm'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'stopSystemVm', u'changeServiceForSystemVm', u'migrateSystemVm', u'scaleSystemVm', u'destroySystemVm', u'listSystemVms', u'startSystemVm', u'rebootSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the system virtual machine'}], u'requiredparams': [u'id'], u'description': u'Destroyes a system virtual machine.'}, u'router': {u'name': u'destroyRouter', u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'rebootRouter'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'rebootRouter', u'destroyRouter'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the router'}], u'requiredparams': [u'id'], u'description': u'Destroys a router.'}, u'virtualmachine': {u'name': u'destroyVirtualMachine', u'related': [u'revertToVMSnapshot', u'listVirtualMachines'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'revertToVMSnapshot', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}], u'requiredparams': [u'id'], u'description': u'Destroys a virtual machine. Once destroyed, only the administrator can recover it.'}}, u'get': {u'apilimit': {u'name': u'getApiLimit', u'related': [u'resetApiLimit'], u'isasync': False, u'params': [], u'requiredparams': [], u'description': u'Get API limit count for the caller'}, u'vmpassword': {u'name': u'getVMPassword', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}], u'requiredparams': [u'id'], u'description': u'Returns an encrypted password for the VM'}, u'user': {u'name': u'getUser', u'related': [u'listUsers', u'updateUser', u'lockUser', u'disableUser'], u'isasync': False, u'params': [{u'name': u'userapikey', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'API key of the user'}], u'requiredparams': [u'userapikey'], u'description': u'Find user account by API key'}, u'cloudidentifier': {u'name': u'getCloudIdentifier', u'related': [], u'isasync': False, u'params': [{u'name': u'userid', u'required': True, u'related': [u'listUsers', u'lockUser'], u'length': 255, u'type': u'uuid', u'description': u'the user ID for the cloud identifier'}], u'requiredparams': [u'userid'], u'description': u'Retrieves a cloud identifier.'}}, u'count': 401, u'enable': {u'user': {u'name': u'enableUser', u'related': [u'createUser', u'listUsers', u'updateUser', u'lockUser', u'getUser', u'disableUser'], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'createUser', u'listUsers', u'updateUser', u'lockUser', u'getUser', u'disableUser', u'enableUser'], u'length': 255, u'type': u'uuid', u'description': u'Enables user by user ID.'}], u'requiredparams': [u'id'], u'description': u'Enables a user account'}, u'account': {u'name': u'enableAccount', u'related': [u'listAccounts', u'disableAccount', u'lockAccount', u'createAccount', u'updateAccount', u'markDefaultZoneForAccount'], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'Enables specified account in this domain.'}, {u'name': u'id', u'required': False, u'related': [u'listAccounts', u'disableAccount', u'lockAccount', u'createAccount', u'updateAccount', u'enableAccount', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'Account id'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Enables specified account.'}], u'requiredparams': [], u'description': u'Enables an account'}, u'storagemaintenance': {u'name': u'enableStorageMaintenance', u'related': [u'updateStoragePool', u'findStoragePoolsForMigration', u'cancelStorageMaintenance', u'createStoragePool', u'listStoragePools'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateStoragePool', u'findStoragePoolsForMigration', u'cancelStorageMaintenance', u'createStoragePool', u'listStoragePools', u'enableStorageMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'Primary storage ID'}], u'requiredparams': [u'id'], u'description': u'Puts storage pool into maintenance state'}, u'staticnat': {u'name': u'enableStaticNat', u'related': [], u'isasync': False, u'params': [{u'name': u'vmguestip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'VM guest nic Secondary ip address for the port forwarding rule'}, {u'name': u'ipaddressid', u'required': True, u'related': [u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the public IP address id for which static nat feature is being enabled'}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'The network of the vm the static nat will be enabled for. Required when public Ip address is not associated with any Guest network yet (VPC case)'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine for enabling static nat feature'}], u'requiredparams': [u'ipaddressid', u'virtualmachineid'], u'description': u'Enables static nat for given ip address'}, u'autoscalevmgroup': {u'name': u'enableAutoScaleVmGroup', u'related': [u'updateAutoScaleVmGroup'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale group'}], u'requiredparams': [u'id'], u'description': u'Enables an AutoScale Vm Group'}}, u'configure': {u'internalloadbalancerelement': {u'name': u'configureInternalLoadBalancerElement', u'related': [], u'isasync': True, u'params': [{u'name': u'enabled', u'required': True, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Enables/Disables the Internal Load Balancer element'}, {u'name': u'id', u'required': True, u'related': [u'configureInternalLoadBalancerElement'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the internal lb provider'}], u'requiredparams': [u'enabled', u'id'], u'description': u'Configures an Internal Load Balancer element.'}, u'virtualrouterelement': {u'name': u'configureVirtualRouterElement', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'configureVirtualRouterElement'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual router provider'}, {u'name': u'enabled', u'required': True, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Enabled/Disabled the service provider'}], u'requiredparams': [u'id', u'enabled'], u'description': u'Configures a virtual router element.'}, u'simulator': {u'name': u'configureSimulator', u'related': [], u'isasync': False, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'which command needs to be configured'}, {u'name': u'value', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'configuration options for this command, which is seperated by ;'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'configure range: in a zone'}, {u'name': u'podid', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'configure range: in a pod'}, {u'name': u'hostid', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'configure range: in a host'}, {u'name': u'clusterid', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'configure range: in a cluster'}], u'requiredparams': [u'name', u'value'], u'description': u'configure simulator'}}, u'associate': {u'ucsprofiletoblade': {u'name': u'associateUcsProfileToBlade', u'related': [u'listUcsBlades'], u'isasync': True, u'params': [{u'name': u'bladeid', u'required': True, u'related': [u'listUcsBlades', u'associateUcsProfileToBlade'], u'length': 255, u'type': u'uuid', u'description': u'blade id'}, {u'name': u'profiledn', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'profile dn'}, {u'name': u'ucsmanagerid', u'required': True, u'related': [u'addUcsManager'], u'length': 255, u'type': u'uuid', u'description': u'ucs manager id'}], u'requiredparams': [u'bladeid', u'profiledn', u'ucsmanagerid'], u'description': u'associate a profile to a blade'}, u'ipaddress': {u'name': u'associateIpAddress', u'related': [], u'isasync': True, u'params': [{u'name': u'regionid', u'required': False, u'related': [u'addRegion'], u'length': 255, u'type': u'integer', u'description': u'region ID from where portable ip is to be associated.'}, {u'name': u'isportable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'should be set to true if public IP is required to be transferable across zones, if not specified defaults to false'}, {u'name': u'zoneid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the availability zone you want to acquire an public IP address from'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain to associate with this IP address'}, {u'name': u'vpcid', u'required': False, u'related': [u'restartVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'the VPC you want the ip address to be associated with'}, {u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'Deploy vm for the project'}, {u'name': u'networkid', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'The network this ip address should be associated to.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account to associate with this IP address'}], u'requiredparams': [], u'description': u'Acquires and associates a public IP to an account.'}}, u'stop': {u'systemvm': {u'name': u'stopSystemVm', u'related': [u'changeServiceForSystemVm', u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'startSystemVm', u'rebootSystemVm'], u'isasync': True, u'params': [{u'name': u'forced', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force stop the VM. The caller knows the VM is stopped.'}, {u'name': u'id', u'required': True, u'related': [u'stopSystemVm', u'changeServiceForSystemVm', u'migrateSystemVm', u'scaleSystemVm', u'listSystemVms', u'startSystemVm', u'rebootSystemVm'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the system virtual machine'}], u'requiredparams': [u'id'], u'description': u'Stops a system VM.'}, u'router': {u'name': u'stopRouter', u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'startInternalLoadBalancerVM', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'rebootRouter', u'destroyRouter'], u'isasync': True, u'params': [{u'name': u'forced', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force stop the VM. The caller knows the VM is stopped.'}, {u'name': u'id', u'required': True, u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'startInternalLoadBalancerVM', u'changeServiceForRouter', u'listInternalLoadBalancerVMs', u'stopRouter', u'rebootRouter', u'destroyRouter'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the router'}], u'requiredparams': [u'id'], u'description': u'Stops a router.'}, u'internalloadbalancervm': {u'name': u'stopInternalLoadBalancerVM', u'related': [u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs'], u'isasync': True, u'params': [{u'name': u'forced', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force stop the VM. The caller knows the VM is stopped.'}, {u'name': u'id', u'required': True, u'related': [u'stopInternalLoadBalancerVM', u'startRouter', u'changeServiceForRouter', u'listInternalLoadBalancerVMs'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the internal lb vm'}], u'requiredparams': [u'id'], u'description': u'Stops an Internal LB vm.'}, u'virtualmachine': {u'name': u'stopVirtualMachine', u'related': [u'revertToVMSnapshot', u'listVirtualMachines', u'destroyVirtualMachine'], u'isasync': True, u'params': [{u'name': u'forced', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend). The caller knows the VM is stopped.'}, {u'name': u'id', u'required': True, u'related': [u'revertToVMSnapshot', u'stopVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}], u'requiredparams': [u'id'], u'description': u'Stops a virtual machine.'}}, u'update': {u'loadbalancerrule': {u'name': u'updateLoadBalancerRule', u'related': [u'listLoadBalancerRules', u'createLoadBalancerRule'], u'isasync': True, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the load balancer rule'}, {u'name': u'algorithm', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'load balancer algorithm (source, roundrobin, leastconn)'}, {u'name': u'description', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the description of the load balancer rule'}, {u'name': u'id', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the id of the load balancer rule to update'}], u'requiredparams': [u'id'], u'description': u'Updates load balancer'}, u'domain': {u'name': u'updateDomain', u'related': [u'listDomainChildren'], u'isasync': False, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'updates domain with this name'}, {u'name': u'id', u'required': True, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'ID of domain to update'}, {u'name': u'networkdomain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"Network domain for the domain's networks; empty string will update domainName with NULL value"}], u'requiredparams': [u'id'], u'description': u'Updates a domain with a new name'}, u'instancegroup': {u'name': u'updateInstanceGroup', u'related': [], u'isasync': False, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'new instance group name'}, {u'name': u'id', u'required': True, u'related': [u'updateInstanceGroup'], u'length': 255, u'type': u'uuid', u'description': u'Instance group ID'}], u'requiredparams': [u'id'], u'description': u'Updates a vm group'}, u'diskoffering': {u'name': u'updateDiskOffering', u'related': [u'listDiskOfferings', u'createDiskOffering'], u'isasync': False, u'params': [{u'name': u'displaytext', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'updates alternate display text of the disk offering with this value'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'updates name of the disk offering with this value'}, {u'name': u'id', u'required': True, u'related': [u'listDiskOfferings', u'createDiskOffering', u'updateDiskOffering'], u'length': 255, u'type': u'uuid', u'description': u'ID of the disk offering'}, {u'name': u'sortkey', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'sort key of the disk offering, integer'}], u'requiredparams': [u'id'], u'description': u'Updates a disk offering.'}, u'virtualmachine': {u'name': u'updateVirtualMachine', u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'restoreVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'isasync': False, u'params': [{u'name': u'ostypeid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the OS type that best represents this VM.'}, {u'name': u'displayvm', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'an optional field, whether to the display the vm to the end user or not.'}, {u'name': u'id', u'required': True, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}, {u'name': u'userdata', u'required': False, u'related': [], u'length': 32768, u'type': u'string', u'description': u'an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 32K of data after base64 encoding.'}, {u'name': u'group', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'group of the virtual machine'}, {u'name': u'isdynamicallyscalable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory'}, {u'name': u'displayname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'user generated name'}, {u'name': u'haenable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if high-availability is enabled for the virtual machine, false otherwise'}], u'requiredparams': [u'id'], u'description': u'Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.'}, u'portforwardingrule': {u'name': u'updatePortForwardingRule', u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules'], u'isasync': True, u'params': [{u'name': u'privateip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the private IP address of the port forwarding rule'}, {u'name': u'protocol', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the protocol for the port fowarding rule. Valid values are TCP or UDP.'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine for the port forwarding rule'}, {u'name': u'ipaddressid', u'required': True, u'related': [u'associateIpAddress', u'restartNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the IP address id of the port forwarding rule'}, {u'name': u'publicport', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the public port of the port forwarding rule'}, {u'name': u'privateport', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the private port of the port forwarding rule'}], u'requiredparams': [u'protocol', u'ipaddressid', u'publicport', u'privateport'], u'description': u'Updates a port forwarding rule. Only the private port and the virtual machine can be updated.'}, u'cluster': {u'name': u'updateCluster', u'related': [], u'isasync': False, u'params': [{u'name': u'clustername', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the cluster name'}, {u'name': u'clustertype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'hypervisor type of the cluster'}, {u'name': u'hypervisor', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'hypervisor type of the cluster'}, {u'name': u'managedstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'whether this cluster is managed by cloudstack'}, {u'name': u'id', u'required': True, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Cluster'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this cluster for allocation of new resources'}], u'requiredparams': [u'id'], u'description': u'Updates an existing cluster'}, u'hostpassword': {u'name': u'updateHostPassword', u'related': [], u'isasync': False, u'params': [{u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the username for the host/cluster'}, {u'name': u'clusterid', u'required': False, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the cluster ID'}, {u'name': u'password', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the new password for the host/cluster'}, {u'name': u'hostid', u'required': False, u'related': [u'addHost', u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the host ID'}], u'requiredparams': [u'username', u'password'], u'description': u'Update password of a host/pool on management server.'}, u'pod': {u'name': u'updatePod', u'related': [], u'isasync': False, u'params': [{u'name': u'gateway', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the gateway for the Pod'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this cluster for allocation of new resources'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the Pod'}, {u'name': u'id', u'required': True, u'related': [u'updatePod'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Pod'}, {u'name': u'endip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IP address for the Pod'}, {u'name': u'netmask', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask of the Pod'}, {u'name': u'startip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the starting IP address for the Pod'}], u'requiredparams': [u'id'], u'description': u'Updates a Pod.'}, u'isopermissions': {u'name': u'updateIsoPermissions', u'related': [], u'isasync': False, u'params': [{u'name': u'isfeatured', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true for featured template/iso, false otherwise'}, {u'name': u'projectids', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'list', u'description': u'a comma delimited list of projects. If specified, "op" parameter has to be passed in.'}, {u'name': u'ispublic', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true for public template/iso, false for private templates/isos'}, {u'name': u'accounts', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'a comma delimited list of accounts. If specified, "op" parameter has to be passed in.'}, {u'name': u'id', u'required': True, u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the template ID'}, {u'name': u'isextractable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template/iso is extractable, false other wise. Can be set only by root admin'}, {u'name': u'op', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'permission operator (add, remove, reset)'}], u'requiredparams': [u'id'], u'description': u'Updates iso permissions'}, u'resourcelimit': {u'name': u'updateResourceLimit', u'related': [u'listResourceLimits'], u'isasync': False, u'params': [{u'name': u'resourcetype', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.6 - Network. Number of guest network a user can create.7 - VPC. Number of VPC a user can create.8 - CPU. Total number of CPU cores a user can use.9 - Memory. Total Memory (in MB) a user can use.10 - PrimaryStorage. Total primary storage space (in GiB) a user can use.11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use.'}, {u'name': u'max', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u' Maximum resource limit.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Update resource for a specified account. Must be used with the domainId parameter.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'Update resource limits for project'}], u'requiredparams': [u'resourcetype'], u'description': u'Updates resource limits for an account or domain.'}, u'vpcoffering': {u'name': u'updateVPCOffering', u'related': [u'listVPCOfferings', u'createVPCOffering'], u'isasync': True, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the VPC offering'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'update state for the VPC offering; supported states - Enabled/Disabled'}, {u'name': u'id', u'required': True, u'related': [u'listVPCOfferings', u'createVPCOffering', u'updateVPCOffering'], u'length': 255, u'type': u'uuid', u'description': u'the id of the VPC offering'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the VPC offering'}], u'requiredparams': [u'id'], u'description': u'Updates VPC offering'}, u'network': {u'name': u'updateNetwork', u'related': [], u'isasync': True, u'params': [{u'name': u'guestvmcidr', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'CIDR for Guest VMs,Cloudstack allocates IPs to Guest VMs only from this CIDR'}, {u'name': u'displaynetwork', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'an optional field, whether to the display the network to the end user or not.'}, {u'name': u'id', u'required': True, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the new name for the network'}, {u'name': u'changecidr', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force update even if cidr type is different'}, {u'name': u'networkofferingid', u'required': False, u'related': [u'updateNetworkOffering'], u'length': 255, u'type': u'uuid', u'description': u'network offering ID'}, {u'name': u'networkdomain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'network domain'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the new display text for the network'}], u'requiredparams': [u'id'], u'description': u'Updates a network'}, u'zone': {u'name': u'updateZone', u'related': [u'createZone', u'listZones'], u'isasync': False, u'params': [{u'name': u'localstorageenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if local storage offering enabled, false otherwise'}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'the details for the Zone'}, {u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Allocation state of this cluster for allocation of new resources'}, {u'name': u'internaldns1', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the first internal DNS for the Zone'}, {u'name': u'ip6dns1', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the first DNS for IPv6 network in the Zone'}, {u'name': u'ispublic', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'updates a private zone to public if set, but not vice-versa'}, {u'name': u'dnssearchorder', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the dns search order list'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the Zone'}, {u'name': u'ip6dns2', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the second DNS for IPv6 network in the Zone'}, {u'name': u'dhcpprovider', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the dhcp Provider for the Zone'}, {u'name': u'internaldns2', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the second internal DNS for the Zone'}, {u'name': u'dns2', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the second DNS for the Zone'}, {u'name': u'domain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Network domain name for the networks in the zone; empty string will update domain with NULL value'}, {u'name': u'id', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Zone'}, {u'name': u'guestcidraddress', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the guest CIDR address for the Zone'}, {u'name': u'dns1', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the first DNS for the Zone'}], u'requiredparams': [u'id'], u'description': u'Updates a Zone.'}, u'projectinvitation': {u'name': u'updateProjectInvitation', u'related': [], u'isasync': True, u'params': [{u'name': u'token', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'list invitations for specified account; this parameter has to be specified with domainId'}, {u'name': u'accept', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'if true, accept the invitation, decline if false. True by default'}, {u'name': u'projectid', u'required': True, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'id of the project to join'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'account that is joining the project'}], u'requiredparams': [u'projectid'], u'description': u'Accepts or declines project invitation'}, u'autoscalepolicy': {u'name': u'updateAutoScalePolicy', u'related': [u'createAutoScalePolicy'], u'isasync': True, u'params': [{u'name': u'duration', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the duration for which the conditions have to be true before action is taken'}, {u'name': u'quiettime', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the cool down period for which the policy should not be evaluated after the action has been taken'}, {u'name': u'conditionids', u'required': False, u'related': [u'listConditions'], u'length': 255, u'type': u'list', u'description': u'the list of IDs of the conditions that are being evaluated on every interval'}, {u'name': u'id', u'required': True, u'related': [u'updateAutoScalePolicy', u'createAutoScalePolicy'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale policy'}], u'requiredparams': [u'id'], u'description': u'Updates an existing autoscale policy.'}, u'globalloadbalancerrule': {u'name': u'updateGlobalLoadBalancerRule', u'related': [u'listGlobalLoadBalancerRules'], u'isasync': True, u'params': [{u'name': u'gslblbmethod', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'"}, {u'name': u'gslbstickysessionmethodname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'session sticky method (sourceip) if not specified defaults to sourceip'}, {u'name': u'description', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the description of the load balancer rule'}, {u'name': u'id', u'required': True, u'related': [u'listGlobalLoadBalancerRules', u'updateGlobalLoadBalancerRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the global load balancer rule'}], u'requiredparams': [u'id'], u'description': u'update global load balancer rules.'}, u'serviceoffering': {u'name': u'updateServiceOffering', u'related': [u'listServiceOfferings', u'createServiceOffering'], u'isasync': False, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the service offering to be updated'}, {u'name': u'id', u'required': True, u'related': [u'updateServiceOffering', u'listServiceOfferings', u'createServiceOffering'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the service offering to be updated'}, {u'name': u'sortkey', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'sort key of the service offering, integer'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the service offering to be updated'}], u'requiredparams': [u'id'], u'description': u'Updates a service offering.'}, u'template': {u'name': u'updateTemplate', u'related': [u'registerIso', u'listIsos', u'updateIso', u'copyIso'], u'isasync': False, u'params': [{u'name': u'passwordenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the image supports the password reset feature; default is false'}, {u'name': u'format', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the format for the image'}, {u'name': u'id', u'required': True, u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'copyIso'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the image file'}, {u'name': u'bootable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if image is bootable, false otherwise'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the image file'}, {u'name': u'ostypeid', u'required': False, u'related': [u'listOsTypes'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the OS type that best represents the OS of this image.'}, {u'name': u'sortkey', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'sort key of the template, integer'}, {u'name': u'isdynamicallyscalable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the display text of the image'}, {u'name': u'isrouting', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template type is routing i.e., if template is used to deploy router'}], u'requiredparams': [u'id'], u'description': u'Updates attributes of a template.'}, u'hypervisorcapabilities': {u'name': u'updateHypervisorCapabilities', u'related': [u'listHypervisorCapabilities'], u'isasync': False, u'params': [{u'name': u'securitygroupenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'set true to enable security group for this hypervisor.'}, {u'name': u'maxguestslimit', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'the max number of Guest VMs per host for this hypervisor.'}, {u'name': u'id', u'required': False, u'related': [u'listHypervisorCapabilities', u'updateHypervisorCapabilities'], u'length': 255, u'type': u'uuid', u'description': u'ID of the hypervisor capability'}], u'requiredparams': [], u'description': u'Updates a hypervisor capabilities.'}, u'storagepool': {u'name': u'updateStoragePool', u'related': [u'findStoragePoolsForMigration', u'cancelStorageMaintenance', u'createStoragePool', u'listStoragePools'], u'isasync': False, u'params': [{u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'comma-separated list of tags for the storage pool'}, {u'name': u'id', u'required': True, u'related': [u'updateStoragePool', u'findStoragePoolsForMigration', u'cancelStorageMaintenance', u'createStoragePool', u'listStoragePools'], u'length': 255, u'type': u'uuid', u'description': u'the Id of the storage pool'}, {u'name': u'capacitybytes', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'bytes CloudStack can provision from this storage pool'}, {u'name': u'capacityiops', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'IOPS CloudStack can provision from this storage pool'}], u'requiredparams': [u'id'], u'description': u'Updates a storage pool.'}, u'defaultnicforvirtualmachine': {u'name': u'updateDefaultNicForVirtualMachine', u'related': [u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'virtualmachineid', u'required': True, u'related': [u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'Virtual Machine ID'}, {u'name': u'nicid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'NIC ID'}], u'requiredparams': [u'virtualmachineid', u'nicid'], u'description': u'Changes the default NIC on a VM'}, u'volume': {u'name': u'updateVolume', u'related': [u'detachVolume', u'createVolume', u'resizeVolume', u'uploadVolume'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'detachVolume', u'createVolume', u'updateVolume', u'resizeVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}, {u'name': u'path', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the path of the volume'}], u'requiredparams': [u'id', u'path'], u'description': u'Updates the volume.'}, u'host': {u'name': u'updateHost', u'related': [u'listHosts', u'prepareHostForMaintenance'], u'isasync': False, u'params': [{u'name': u'allocationstate', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable'}, {u'name': u'url', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the new uri for the secondary storage: nfs://host/path'}, {u'name': u'id', u'required': True, u'related': [u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the host to update'}, {u'name': u'oscategoryid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the id of Os category to update the host with'}, {u'name': u'hosttags', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list of tags to be added to the host'}], u'requiredparams': [u'id'], u'description': u'Updates a host.'}, u'networkaclitem': {u'name': u'updateNetworkACLItem', u'related': [u'createNetworkACL'], u'isasync': True, u'params': [{u'name': u'action', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'scl entry action, allow or deny'}, {u'name': u'endport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the ending port of ACL'}, {u'name': u'traffictype', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the traffic type for the ACL,can be Ingress or Egress, defaulted to Ingress if not specified'}, {u'name': u'number', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'The network of the vm the ACL will be created for'}, {u'name': u'cidrlist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the cidr list to allow traffic from/to'}, {u'name': u'protocol', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number'}, {u'name': u'icmpcode', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'error code for this icmp message'}, {u'name': u'startport', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the starting port of ACL'}, {u'name': u'icmptype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'type of the icmp message being sent'}, {u'name': u'id', u'required': True, u'related': [u'createNetworkACL', u'updateNetworkACLItem'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network ACL Item'}], u'requiredparams': [u'id'], u'description': u'Updates ACL Item with specified Id'}, u'vpc': {u'name': u'updateVPC', u'related': [u'restartVPC', u'createVPC', u'listVPCs'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateVPC', u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'the id of the VPC'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the VPC'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the VPC'}], u'requiredparams': [u'id', u'name'], u'description': u'Updates a VPC'}, u'resourcecount': {u'name': u'updateResourceCount', u'related': [], u'isasync': False, u'params': [{u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'Update resource limits for project'}, {u'name': u'domainid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.'}, {u'name': u'resourcetype', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.5 - Project. Number of projects that a user can create.6 - Network. Number of guest network a user can create.7 - VPC. Number of VPC a user can create.8 - CPU. Total number of CPU cores a user can use.9 - Memory. Total Memory (in MB) a user can use.10 - PrimaryStorage. Total primary storage space (in GiB) a user can use.11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Update resource count for a specified account. Must be used with the domainId parameter.'}], u'requiredparams': [u'domainid'], u'description': u'Recalculate and update resource count for an account or domain.'}, u'storagenetworkiprange': {u'name': u'updateStorageNetworkIpRange', u'related': [u'listStorageNetworkIpRange'], u'isasync': True, u'params': [{u'name': u'startip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the beginning IP address'}, {u'name': u'netmask', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the netmask for storage network'}, {u'name': u'id', u'required': True, u'related': [u'listStorageNetworkIpRange', u'updateStorageNetworkIpRange'], u'length': 255, u'type': u'uuid', u'description': u'UUID of storage network ip range'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Optional. the vlan the ip range sits on'}, {u'name': u'endip', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the ending IP address'}], u'requiredparams': [u'id'], u'description': u'Update a Storage network IP range, only allowed when no IPs in this range have been allocated.'}, u'configuration': {u'name': u'updateConfiguration', u'related': [u'listConfigurations'], u'isasync': False, u'params': [{u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Zone to update the parameter value for corresponding zone'}, {u'name': u'value', u'required': False, u'related': [], u'length': 4095, u'type': u'string', u'description': u'the value of the configuration'}, {u'name': u'clusterid', u'required': False, u'related': [u'listClusters', u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Cluster to update the parameter value for corresponding cluster'}, {u'name': u'storageid', u'required': False, u'related': [u'updateStoragePool', u'findStoragePoolsForMigration', u'cancelStorageMaintenance', u'createStoragePool', u'listStoragePools', u'enableStorageMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Storage pool to update the parameter value for corresponding storage pool'}, {u'name': u'accountid', u'required': False, u'related': [u'listAccounts', u'disableAccount', u'lockAccount', u'createAccount', u'updateAccount', u'enableAccount', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Account to update the parameter value for corresponding account'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the configuration'}], u'requiredparams': [u'name'], u'description': u'Updates a configuration.'}, u'templatepermissions': {u'name': u'updateTemplatePermissions', u'related': [], u'isasync': False, u'params': [{u'name': u'isextractable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template/iso is extractable, false other wise. Can be set only by root admin'}, {u'name': u'accounts', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'a comma delimited list of accounts. If specified, "op" parameter has to be passed in.'}, {u'name': u'op', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'permission operator (add, remove, reset)'}, {u'name': u'ispublic', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true for public template/iso, false for private templates/isos'}, {u'name': u'isfeatured', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true for featured template/iso, false otherwise'}, {u'name': u'projectids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'a comma delimited list of projects. If specified, "op" parameter has to be passed in.'}, {u'name': u'id', u'required': True, u'related': [u'listIsos'], u'length': 255, u'type': u'uuid', u'description': u'the template ID'}], u'requiredparams': [u'id'], u'description': u'Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A priviledged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.'}, u'autoscalevmprofile': {u'name': u'updateAutoScaleVmProfile', u'related': [u'listAutoScaleVmProfiles'], u'isasync': True, u'params': [{u'name': u'autoscaleuserid', u'required': False, u'related': [u'createUser', u'listUsers', u'updateUser', u'lockUser', u'getUser', u'disableUser', u'enableUser'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the user used to launch and destroy the VMs'}, {u'name': u'templateid', u'required': False, u'related': [u'updateTemplate', u'registerTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the template of the auto deployed virtual machine'}, {u'name': u'destroyvmgraceperiod', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the time allowed for existing connections to get closed before a vm is destroyed'}, {u'name': u'id', u'required': True, u'related': [u'updateAutoScaleVmProfile', u'listAutoScaleVmProfiles'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale vm profile'}, {u'name': u'counterparam', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161'}], u'requiredparams': [u'id'], u'description': u'Updates an existing autoscale vm profile.'}, u'traffictype': {u'name': u'updateTrafficType', u'related': [u'addTrafficType'], u'isasync': True, u'params': [{u'name': u'xennetworklabel', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The network name label of the physical device dedicated to this traffic on a XenServer host'}, {u'name': u'vmwarenetworklabel', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The network name label of the physical device dedicated to this traffic on a VMware host'}, {u'name': u'kvmnetworklabel', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The network name label of the physical device dedicated to this traffic on a KVM host'}, {u'name': u'id', u'required': True, u'related': [u'addTrafficType', u'updateTrafficType'], u'length': 255, u'type': u'uuid', u'description': u'traffic type id'}], u'requiredparams': [u'id'], u'description': u'Updates traffic type of a physical network'}, u'account': {u'name': u'updateAccount', u'related': [u'listAccounts', u'disableAccount', u'lockAccount', u'createAccount', u'markDefaultZoneForAccount'], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the domain where the account exists'}, {u'name': u'id', u'required': False, u'related': [u'listAccounts', u'disableAccount', u'lockAccount', u'createAccount', u'updateAccount', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'Account id'}, {u'name': u'networkdomain', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u"Network domain for the account's networks; empty string will update domainName with NULL value"}, {u'name': u'newname', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'new name for the account'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the current account name'}, {u'name': u'accountdetails', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'details for account used to store specific parameters'}], u'requiredparams': [u'newname'], u'description': u'Updates account information for the authenticated user'}, u'vmaffinitygroup': {u'name': u'updateVMAffinityGroup', u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}, {u'name': u'affinitygroupnames', u'required': False, u'related': [u'listAffinityGroups'], u'length': 255, u'type': u'list', u'description': u'comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter'}, {u'name': u'affinitygroupids', u'required': False, u'related': [u'listAffinityGroups'], u'length': 255, u'type': u'list', u'description': u'comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter'}], u'requiredparams': [u'id'], u'description': u'Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.'}, u'physicalnetwork': {u'name': u'updatePhysicalNetwork', u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork'], u'isasync': True, u'params': [{u'name': u'networkspeed', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the speed for the physical network[1G/10G]'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Enabled/Disabled'}, {u'name': u'id', u'required': True, u'related': [u'listPhysicalNetworks', u'createPhysicalNetwork', u'updatePhysicalNetwork'], u'length': 255, u'type': u'uuid', u'description': u'physical network id'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'Tag the physical network'}, {u'name': u'vlan', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the VLAN for the physical network'}], u'requiredparams': [u'id'], u'description': u'Updates a physical network'}, u'region': {u'name': u'updateRegion', u'related': [u'addRegion', u'listRegions'], u'isasync': False, u'params': [{u'name': u'endpoint', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'updates region with this end point'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'updates region with this name'}, {u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'Id of region to update'}], u'requiredparams': [u'id'], u'description': u'Updates a region'}, u'networkoffering': {u'name': u'updateNetworkOffering', u'related': [], u'isasync': False, u'params': [{u'name': u'sortkey', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'sort key of the network offering, integer'}, {u'name': u'maxconnections', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'maximum number of concurrent connections supported by the network offering'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the network offering'}, {u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'update state for the network offering'}, {u'name': u'id', u'required': False, u'related': [u'updateNetworkOffering'], u'length': 255, u'type': u'uuid', u'description': u'the id of the network offering'}, {u'name': u'availability', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the display text of the network offering'}], u'requiredparams': [], u'description': u'Updates a network offering.'}, u'project': {u'name': u'updateProject', u'related': [u'createProject'], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'new Admin account for the project'}, {u'name': u'id', u'required': True, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'id of the project to be modified'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'display text of the project'}], u'requiredparams': [u'id'], u'description': u'Updates a project'}, u'vpncustomergateway': {u'name': u'updateVpnCustomerGateway', u'related': [], u'isasync': True, u'params': [{u'name': u'ikepolicy', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'IKE policy of the customer gateway'}, {u'name': u'ikelifetime', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'Lifetime of phase 1 VPN connection to the customer gateway, in seconds'}, {u'name': u'esppolicy', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'ESP policy of the customer gateway'}, {u'name': u'id', u'required': True, u'related': [u'updateVpnCustomerGateway'], u'length': 255, u'type': u'uuid', u'description': u'id of customer gateway'}, {u'name': u'cidrlist', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'guest cidr of the customer gateway'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account associated with the gateway. Must be used with the domainId parameter.'}, {u'name': u'dpd', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'If DPD is enabled for VPN connection'}, {u'name': u'esplifetime', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'Lifetime of phase 2 VPN connection to the customer gateway, in seconds'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of this customer gateway'}, {u'name': u'ipsecpsk', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'IPsec Preshared-Key of the customer gateway'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.'}, {u'name': u'gateway', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'public ip address id of the customer gateway'}], u'requiredparams': [u'ikepolicy', u'esppolicy', u'id', u'cidrlist', u'ipsecpsk', u'gateway'], u'description': u'Update site to site vpn customer gateway'}, u'iso': {u'name': u'updateIso', u'related': [u'listIsos'], u'isasync': False, u'params': [{u'name': u'isdynamicallyscalable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory'}, {u'name': u'displaytext', u'required': False, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the display text of the image'}, {u'name': u'bootable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if image is bootable, false otherwise'}, {u'name': u'ostypeid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the OS type that best represents the OS of this image.'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the image file'}, {u'name': u'format', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the format for the image'}, {u'name': u'passwordenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the image supports the password reset feature; default is false'}, {u'name': u'sortkey', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'sort key of the template, integer'}, {u'name': u'id', u'required': True, u'related': [u'listIsos', u'updateIso'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the image file'}, {u'name': u'isrouting', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template type is routing i.e., if template is used to deploy router'}], u'requiredparams': [u'id'], u'description': u'Updates an ISO file.'}, u'networkserviceprovider': {u'name': u'updateNetworkServiceProvider', u'related': [], u'isasync': True, u'params': [{u'name': u'state', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Enabled/Disabled/Shutdown the physical network service provider'}, {u'name': u'servicelist', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the list of services to be enabled for this physical network service provider'}, {u'name': u'id', u'required': True, u'related': [u'updateNetworkServiceProvider'], u'length': 255, u'type': u'uuid', u'description': u'network service provider id'}], u'requiredparams': [u'id'], u'description': u'Updates a network serviceProvider of a physical network'}, u'autoscalevmgroup': {u'name': u'updateAutoScaleVmGroup', u'related': [], u'isasync': True, u'params': [{u'name': u'interval', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the frequency at which the conditions have to be evaluated'}, {u'name': u'minmembers', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.'}, {u'name': u'maxmembers', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.'}, {u'name': u'scaledownpolicyids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list of scaledown autoscale policies'}, {u'name': u'scaleuppolicyids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list of scaleup autoscale policies'}, {u'name': u'id', u'required': True, u'related': [u'updateAutoScaleVmGroup'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale group'}], u'requiredparams': [u'id'], u'description': u'Updates an existing autoscale vm group.'}, u'user': {u'name': u'updateUser', u'related': [u'listUsers', u'lockUser', u'disableUser'], u'isasync': False, u'params': [{u'name': u'timezone', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.'}, {u'name': u'firstname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'first name'}, {u'name': u'username', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Unique username'}, {u'name': u'lastname', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'last name'}, {u'name': u'password', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Clear text password (default hashed to SHA256SALT). If you wish to use any other hasing algorithm, you would need to write a custom authentication adapter'}, {u'name': u'id', u'required': True, u'related': [u'listUsers', u'updateUser', u'lockUser', u'disableUser'], u'length': 255, u'type': u'uuid', u'description': u'User uuid'}, {u'name': u'email', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'email'}, {u'name': u'userapikey', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The API key for the user. Must be specified with userSecretKey'}, {u'name': u'usersecretkey', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The secret key for the user. Must be specified with userApiKey'}], u'requiredparams': [u'id'], u'description': u'Updates a user account'}}, u'upload': {u'volume': {u'name': u'uploadVolume', u'related': [], u'isasync': True, u'params': [{u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL of where the volume is hosted. Possible URL include http:// and https://'}, {u'name': u'format', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the format for the volume. Possible values include QCOW2, OVA, and VHD.'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'Upload volume for the project'}, {u'name': u'zoneid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone the volume is to be hosted on'}, {u'name': u'imagestoreuuid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Image store uuid'}, {u'name': u'domainid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId. If the account parameter is used, domainId must also be used.'}, {u'name': u'checksum', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the MD5 checksum value of this volume'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional accountName. Must be used with domainId.'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the volume'}], u'requiredparams': [u'url', u'format', u'zoneid', u'name'], u'description': u'Uploads a data disk.'}, u'customcertificate': {u'name': u'uploadCustomCertificate', u'related': [], u'isasync': True, u'params': [{u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'A name / alias for the certificate.'}, {u'name': u'privatekey', u'required': False, u'related': [], u'length': 65535, u'type': u'string', u'description': u'The private key for the attached certificate.'}, {u'name': u'certificate', u'required': True, u'related': [], u'length': 65535, u'type': u'string', u'description': u'The certificate to be uploaded.'}, {u'name': u'domainsuffix', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'DNS domain suffix that the certificate is granted for.'}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3'}], u'requiredparams': [u'certificate', u'domainsuffix'], u'description': u'Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.'}}, u'disable': {u'account': {u'name': u'disableAccount', u'related': [u'listAccounts', u'markDefaultZoneForAccount'], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Disables specified account.'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'Disables specified account in this domain.'}, {u'name': u'lock', u'required': True, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'If true, only lock the account; else disable the account'}, {u'name': u'id', u'required': False, u'related': [u'listAccounts', u'disableAccount', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'Account id'}], u'requiredparams': [u'lock'], u'description': u'Disables an account'}, u'user': {u'name': u'disableUser', u'related': [u'listUsers', u'lockUser'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listUsers', u'lockUser', u'disableUser'], u'length': 255, u'type': u'uuid', u'description': u'Disables user by user ID.'}], u'requiredparams': [u'id'], u'description': u'Disables a user account'}, u'staticnat': {u'name': u'disableStaticNat', u'related': [], u'isasync': True, u'params': [{u'name': u'ipaddressid', u'required': True, u'related': [u'associateIpAddress'], u'length': 255, u'type': u'uuid', u'description': u'the public IP address id for which static nat feature is being disableed'}], u'requiredparams': [u'ipaddressid'], u'description': u'Disables static rule for given ip address'}, u'autoscalevmgroup': {u'name': u'disableAutoScaleVmGroup', u'related': [u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'disableAutoScaleVmGroup', u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale group'}], u'requiredparams': [u'id'], u'description': u'Disables an AutoScale Vm Group'}}, u'resize': {u'volume': {u'name': u'resizeVolume', u'related': [u'detachVolume', u'createVolume', u'uploadVolume'], u'isasync': True, u'params': [{u'name': u'shrinkok', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Verify OK to Shrink'}, {u'name': u'size', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'New volume size in G'}, {u'name': u'diskofferingid', u'required': False, u'related': [u'listDiskOfferings', u'createDiskOffering', u'updateDiskOffering'], u'length': 255, u'type': u'uuid', u'description': u'new disk offering id'}, {u'name': u'id', u'required': False, u'related': [u'detachVolume', u'createVolume', u'resizeVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}], u'requiredparams': [], u'description': u'Resizes a volume'}}, u'detach': {u'volume': {u'name': u'detachVolume', u'related': [u'createVolume', u'uploadVolume'], u'isasync': True, u'params': [{u'name': u'id', u'required': False, u'related': [u'detachVolume', u'createVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the disk volume'}, {u'name': u'virtualmachineid', u'required': False, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the virtual machine where the volume is detached from'}, {u'name': u'deviceid', u'required': False, u'related': [], u'length': 255, u'type': u'long', u'description': u'the device ID on the virtual machine where volume is detached from'}], u'requiredparams': [], u'description': u'Detaches a disk volume from a virtual machine.'}, u'iso': {u'name': u'detachIso', u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'virtualmachineid', u'required': True, u'related': [u'revertToVMSnapshot', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}], u'requiredparams': [u'virtualmachineid'], u'description': u'Detaches any ISO file (if any) currently attached to a virtual machine.'}}, u'asyncapis': [u'createCondition', u'reconnectHost', u'copyTemplate', u'addNicToVirtualMachine', u'extractVolume', u'addAccountToProject', u'deleteEgressFirewallRule', u'createVpnConnection', u'suspendProject', u'deleteLoadBalancer', u'authorizeSecurityGroupIngress', u'deleteDomain', u'createPortableIpRange', u'createTemplate', u'migrateVolume', u'deleteLBHealthCheckPolicy', u'updatePhysicalNetwork', u'deleteStaticRoute', u'destroySystemVm', u'enableStorageMaintenance', u'removeFromGlobalLoadBalancerRule', u'stopRouter', u'attachVolume', u'updateVPCOffering', u'resetSSHKeyForVirtualMachine', u'cleanVMReservations', u'createAffinityGroup', u'deleteTags', u'deleteAccountFromProject', u'addBaremetalPxePingServer', u'deletePortableIpRange', u'updateVolume', u'uploadCustomCertificate', u'createAutoScaleVmProfile', u'releaseDedicatedGuestVlanRange', u'cancelHostMaintenance', u'releaseDedicatedHost', u'deleteStorageNetworkIpRange', u'createInternalLoadBalancerElement', u'deleteFirewallRule', u'deleteProject', u'removeIpFromNic', u'deleteIpForwardingRule', u'createGlobalLoadBalancerRule', u'resizeVolume', u'createStaticRoute', u'deleteGlobalLoadBalancerRule', u'activateProject', u'releaseDedicatedZone', u'createVMSnapshot', u'createIpForwardingRule', u'releaseDedicatedCluster', u'updateVPC', u'startInternalLoadBalancerVM', u'associateUcsProfileToBlade', u'updateAutoScaleVmProfile', u'updatePortForwardingRule', u'createStorageNetworkIpRange', u'createLoadBalancer', u'cancelStorageMaintenance', u'deployVirtualMachine', u'revokeSecurityGroupEgress', u'createNetworkACLList', u'deleteCondition', u'createPortForwardingRule', u'createVPCOffering', u'createEgressFirewallRule', u'destroyRouter', u'assignToGlobalLoadBalancerRule', u'updateTrafficType', u'addIpToNic', u'updateNetworkACLItem', u'deleteNetworkACLList', u'configureInternalLoadBalancerElement', u'releaseHostReservation', u'deleteVpnGateway', u'createAutoScaleVmGroup', u'deleteNetworkServiceProvider', u'rebootRouter', u'createLBHealthCheckPolicy', u'deleteIso', u'createVpnCustomerGateway', u'deleteAutoScalePolicy', u'detachVolume', u'deleteNetworkACL', u'deleteVPC', u'updateLoadBalancerRule', u'createPhysicalNetwork', u'deleteTemplate', u'deleteVpnCustomerGateway', u'createVirtualRouterElement', u'updateAutoScalePolicy', u'releaseDedicatedPod', u'dedicateZone', u'createVpnGateway', u'deleteCounter', u'dedicateCluster', u'updateStorageNetworkIpRange', u'dedicatePod', u'deleteAutoScaleVmGroup', u'updateGlobalLoadBalancerRule', u'disableAutoScaleVmGroup', u'authorizeSecurityGroupEgress', u'prepareHostForMaintenance', u'deletePrivateGateway', u'stopInternalLoadBalancerVM', u'deleteTrafficType', u'deleteLoadBalancerRule', u'attachIso', u'deletePortForwardingRule', u'updateProjectInvitation', u'createTags', u'enableAutoScaleVmGroup', u'removeVpnUser', u'scaleVirtualMachine', u'updateVpnCustomerGateway', u'stopSystemVm', u'restartNetwork', u'rebootVirtualMachine', u'updateVMAffinityGroup', u'deleteVpnConnection', u'startSystemVm', u'updateProject', u'deleteNetwork', u'addTrafficType', u'disableUser', u'configureVirtualRouterElement', u'deleteProjectInvitation', u'migrateSystemVm', u'removeNicFromVirtualMachine', u'revokeSecurityGroupIngress', u'updateDefaultNicForVirtualMachine', u'disableStaticNat', u'createNetworkACL', u'createVPC', u'addBaremetalPxeKickStartServer', u'addResourceDetail', u'disassociateIpAddress', u'createVolume', u'resetPasswordForVirtualMachine', u'assignToLoadBalancerRule', u'startRouter', u'extractIso', u'removeResourceDetail', u'deleteRemoteAccessVpn', u'resetVpnConnection', u'createRemoteAccessVpn', u'extractTemplate', u'startVirtualMachine', u'detachIso', u'deleteAccount', u'associateIpAddress', u'disableAccount', u'migrateVirtualMachine', u'removeFromLoadBalancerRule', u'addVpnUser', u'deleteLBStickinessPolicy', u'createPrivateGateway', u'deleteVMSnapshot', u'deleteAutoScaleVmProfile', u'deleteSnapshot', u'createProject', u'createLoadBalancerRule', u'createAutoScalePolicy', u'restoreVirtualMachine', u'deleteAffinityGroup', u'copyIso', u'uploadVolume', u'createLBStickinessPolicy', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'createCounter', u'createSnapshot', u'updateNetwork', u'destroyVirtualMachine', u'dedicateHost', u'createFirewallRule', u'addNetworkServiceProvider', u'rebootSystemVm', u'revertToVMSnapshot', u'markDefaultZoneForAccount', u'restartVPC', u'replaceNetworkACLList', u'scaleSystemVm', u'updateAutoScaleVmGroup', u'deletePhysicalNetwork', u'addBaremetalDhcp', u'deleteVPCOffering', u'updateNetworkServiceProvider'], u'generate': {u'usagerecords': {u'name': u'generateUsageRecords', u'related': [], u'isasync': False, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'List events for the specified domain.'}, {u'name': u'startdate', u'required': True, u'related': [], u'length': 255, u'type': u'date', u'description': u'Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.'}, {u'name': u'enddate', u'required': True, u'related': [], u'length': 255, u'type': u'date', u'description': u'End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.'}], u'requiredparams': [u'startdate', u'enddate'], u'description': u'Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed'}}, u'restart': {u'network': {u'name': u'restartNetwork', u'related': [u'associateIpAddress'], u'isasync': True, u'params': [{u'name': u'cleanup', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'If cleanup old network elements'}, {u'name': u'id', u'required': True, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'The id of the network to restart.'}], u'requiredparams': [u'id'], u'description': u'Restarts the network; includes 1) restarting network elements - virtual routers, dhcp servers 2) reapplying all public ips 3) reapplying loadBalancing/portForwarding rules'}, u'vpc': {u'name': u'restartVPC', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'restartVPC'], u'length': 255, u'type': u'uuid', u'description': u'the id of the VPC'}], u'requiredparams': [u'id'], u'description': u'Restarts a VPC'}}, u'reset': {u'apilimit': {u'name': u'resetApiLimit', u'related': [], u'isasync': False, u'params': [{u'name': u'account', u'required': False, u'related': [u'listAccounts', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the acount whose limit to be reset'}], u'requiredparams': [], u'description': u'Reset api count'}, u'sshkeyforvirtualmachine': {u'name': u'resetSSHKeyForVirtualMachine', u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the ssh key. Must be used with domainId.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'an optional project for the ssh key'}, {u'name': u'id', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'rebootVirtualMachine', u'assignVirtualMachine', u'deployVirtualMachine', u'attachIso', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'updateVMAffinityGroup', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'recoverVirtualMachine', u'updateDefaultNicForVirtualMachine', u'resetSSHKeyForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.'}, {u'name': u'keypair', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the ssh key pair used to login to the virtual machine'}], u'requiredparams': [u'id', u'keypair'], u'description': u'Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async]'}, u'passwordforvirtualmachine': {u'name': u'resetPasswordForVirtualMachine', u'related': [u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the virtual machine'}], u'requiredparams': [u'id'], u'description': u'Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async]'}, u'vpnconnection': {u'name': u'resetVpnConnection', u'related': [u'listVpnConnections'], u'isasync': True, u'params': [{u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for connection. If the account parameter is used, domainId must also be used.'}, {u'name': u'id', u'required': True, u'related': [u'listVpnConnections', u'resetVpnConnection'], u'length': 255, u'type': u'uuid', u'description': u'id of vpn connection'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for connection. Must be used with domainId.'}], u'requiredparams': [u'id'], u'description': u'Reset site to site vpn connection'}}, u'register': {u'userkeys': {u'name': u'registerUserKeys', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listUsers', u'lockUser'], u'length': 255, u'type': u'uuid', u'description': u'User id'}], u'requiredparams': [u'id'], u'description': u'This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user'}, u'iso': {u'name': u'registerIso', u'related': [u'listIsos', u'updateIso', u'copyIso'], u'isasync': False, u'params': [{u'name': u'isextractable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the iso or its derivatives are extractable; default is false'}, {u'name': u'checksum', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the MD5 checksum value of this ISO'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL to where the ISO is currently being hosted'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account name. Must be used with domainId.'}, {u'name': u'ispublic', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if you want to register the ISO to be publicly available to all users, false otherwise.'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the ISO'}, {u'name': u'bootable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if this ISO is bootable. If not passed explicitly its assumed to be true'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the display text of the ISO. This is usually used for display purposes.'}, {u'name': u'imagestoreuuid', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Image store uuid'}, {u'name': u'ostypeid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the OS Type that best represents the OS of this ISO. If the iso is bootable this parameter needs to be passed'}, {u'name': u'isfeatured', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if you want this ISO to be featured'}, {u'name': u'projectid', u'required': False, u'related': [u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'Register iso for the project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId. If the account parameter is used, domainId must also be used.'}, {u'name': u'zoneid', u'required': True, u'related': [u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone you wish to register the ISO to.'}, {u'name': u'isdynamicallyscalable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if iso contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory'}], u'requiredparams': [u'url', u'name', u'displaytext', u'zoneid'], u'description': u'Registers an existing ISO into the CloudStack Cloud.'}, u'sshkeypair': {u'name': u'registerSSHKeyPair', u'related': [u'listSSHKeyPairs', u'createSSHKeyPair'], u'isasync': False, u'params': [{u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'listProjects', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'an optional project for the ssh key'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of the keypair'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the ssh key. Must be used with domainId.'}, {u'name': u'publickey', u'required': True, u'related': [], u'length': 5120, u'type': u'string', u'description': u'Public key material of the keypair'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.'}], u'requiredparams': [u'name', u'publickey'], u'description': u'Register a public key in a keypair under a certain name'}, u'template': {u'name': u'registerTemplate', u'related': [u'updateTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'isasync': False, u'params': [{u'name': u'hypervisor', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the target hypervisor for the template'}, {u'name': u'requireshvm', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if this template requires HVM'}, {u'name': u'format', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the format for the template. Possible values include QCOW2, RAW, and VHD.'}, {u'name': u'ispublic', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template is available to all accounts; default is true'}, {u'name': u'bits', u'required': False, u'related': [], u'length': 255, u'type': u'integer', u'description': u'32 or 64 bits support. 64 by default'}, {u'name': u'sshkeyenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template supports the sshkey upload feature; default is false'}, {u'name': u'url', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the URL of where the template is hosted. Possible URL include http:// and https://'}, {u'name': u'checksum', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the MD5 checksum value of this template'}, {u'name': u'passwordenabled', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template supports the password reset feature; default is false'}, {u'name': u'details', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'Template details in key/value pairs.'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional accountName. Must be used with domainId.'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone the template is to be hosted on'}, {u'name': u'ostypeid', u'required': True, u'related': [u'listOsTypes'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the OS Type that best represents the OS of this template.'}, {u'name': u'isrouting', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template type is routing i.e., if template is used to deploy router'}, {u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the template'}, {u'name': u'isextractable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if the template or its derivatives are extractable; default is false'}, {u'name': u'templatetag', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the tag for this template.'}, {u'name': u'isdynamicallyscalable', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId. If the account parameter is used, domainId must also be used.'}, {u'name': u'isfeatured', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if this template is a featured template, false otherwise'}, {u'name': u'displaytext', u'required': True, u'related': [], u'length': 4096, u'type': u'string', u'description': u'the display text of the template. This is usually used for display purposes.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'Register template for the project'}], u'requiredparams': [u'hypervisor', u'format', u'url', u'zoneid', u'ostypeid', u'name', u'displaytext'], u'description': u'Registers an existing template into the CloudStack cloud. '}}, u'revert': {u'tovmsnapshot': {u'name': u'revertToVMSnapshot', u'related': [u'listVirtualMachines'], u'isasync': True, u'params': [{u'name': u'vmsnapshotid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The ID of the vm snapshot'}], u'requiredparams': [u'vmsnapshotid'], u'description': u'Revert VM from a vmsnapshot.'}}, u'dedicate': {u'publiciprange': {u'name': u'dedicatePublicIpRange', u'related': [u'listVlanIpRanges'], u'isasync': False, u'params': [{u'name': u'domainid', u'required': True, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'domain ID of the account owning a VLAN'}, {u'name': u'id', u'required': True, u'related': [u'listVlanIpRanges', u'dedicatePublicIpRange'], u'length': 255, u'type': u'uuid', u'description': u'the id of the VLAN IP range'}, {u'name': u'projectid', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'project who will own the VLAN'}, {u'name': u'account', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'account who will own the VLAN'}], u'requiredparams': [u'domainid', u'id', u'account'], u'description': u'Dedicates a Public IP range to an account'}, u'zone': {u'name': u'dedicateZone', u'related': [u'listDedicatedZones'], u'isasync': True, u'params': [{u'name': u'domainid', u'required': True, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the containing domain'}, {u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account which needs dedication. Must be used with domainId.'}], u'requiredparams': [u'domainid', u'zoneid'], u'description': u'Dedicates a zones.'}, u'guestvlanrange': {u'name': u'dedicateGuestVlanRange', u'related': [], u'isasync': False, u'params': [{u'name': u'vlanrange', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'guest vlan range to be dedicated'}, {u'name': u'domainid', u'required': True, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'domain ID of the account owning a VLAN'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'project who will own the VLAN'}, {u'name': u'account', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'account who will own the VLAN'}, {u'name': u'physicalnetworkid', u'required': True, u'related': [u'listPhysicalNetworks'], u'length': 255, u'type': u'uuid', u'description': u'physical network ID of the vlan'}], u'requiredparams': [u'vlanrange', u'domainid', u'account', u'physicalnetworkid'], u'description': u'Dedicates a guest vlan range to an account'}, u'cluster': {u'name': u'dedicateCluster', u'related': [], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account which needs dedication. Must be used with domainId.'}, {u'name': u'domainid', u'required': True, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the containing domain'}, {u'name': u'clusterid', u'required': True, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Cluster'}], u'requiredparams': [u'domainid', u'clusterid'], u'description': u'Dedicate an existing cluster'}, u'host': {u'name': u'dedicateHost', u'related': [], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account which needs dedication. Must be used with domainId.'}, {u'name': u'hostid', u'required': True, u'related': [u'listHosts'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the host to update'}, {u'name': u'domainid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the containing domain'}], u'requiredparams': [u'hostid', u'domainid'], u'description': u'Dedicates a host.'}, u'pod': {u'name': u'dedicatePod', u'related': [], u'isasync': True, u'params': [{u'name': u'domainid', u'required': True, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the containing domain'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the name of the account which needs dedication. Must be used with domainId.'}, {u'name': u'podid', u'required': True, u'related': [u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Pod'}], u'requiredparams': [u'domainid', u'podid'], u'description': u'Dedicates a Pod.'}}, u'remove': {u'fromgloballoadbalancerrule': {u'name': u'removeFromGlobalLoadBalancerRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listGlobalLoadBalancerRules', u'createGlobalLoadBalancerRule', u'updateGlobalLoadBalancerRule'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the load balancer rule'}, {u'name': u'loadbalancerrulelist', u'required': True, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'list', u'description': u'the list load balancer rules that will be assigned to gloabal load balacner rule'}], u'requiredparams': [u'id', u'loadbalancerrulelist'], u'description': u'Removes a load balancer rule association with global load balancer rule'}, u'fromloadbalancerrule': {u'name': u'removeFromLoadBalancerRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the load balancer rule'}, {u'name': u'virtualmachineids', u'required': True, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'list', u'description': u'the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)'}], u'requiredparams': [u'id', u'virtualmachineids'], u'description': u'Removes a virtual machine or a list of virtual machines from a load balancer rule.'}, u'resourcedetail': {u'name': u'removeResourceDetail', u'related': [], u'isasync': True, u'params': [{u'name': u'resourcetype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Delete detail by resource type'}, {u'name': u'resourceid', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Delete details for resource id'}, {u'name': u'key', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'Delete details matching key/value pairs'}], u'requiredparams': [u'resourcetype', u'resourceid'], u'description': u'Removes detail for the Resource.'}, u'region': {u'name': u'removeRegion', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'integer', u'description': u'ID of the region to delete'}], u'requiredparams': [u'id'], u'description': u'Removes specified region'}, u'nicfromvirtualmachine': {u'name': u'removeNicFromVirtualMachine', u'related': [u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'isasync': True, u'params': [{u'name': u'nicid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'NIC ID'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'removeNicFromVirtualMachine', u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'resetPasswordForVirtualMachine', u'listVirtualMachines', u'updateDefaultNicForVirtualMachine', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'Virtual Machine ID'}], u'requiredparams': [u'nicid', u'virtualmachineid'], u'description': u'Removes VM from specified network by deleting a NIC'}, u'vpnuser': {u'name': u'removeVpnUser', u'related': [], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'an optional account for the vpn user. Must be used with domainId.'}, {u'name': u'username', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'username for the vpn user'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'remove vpn user from the project'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.'}], u'requiredparams': [u'username'], u'description': u'Removes vpn user'}, u'ipfromnic': {u'name': u'removeIpFromNic', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'addIpToNic'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the secondary ip address to nic'}], u'requiredparams': [u'id'], u'description': u'Assigns secondary IP to NIC.'}}, u'mark': {u'defaultzoneforaccount': {u'name': u'markDefaultZoneForAccount', u'related': [], u'isasync': True, u'params': [{u'name': u'domainid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'Marks the account that belongs to the specified domain.'}, {u'name': u'account', u'required': True, u'related': [u'markDefaultZoneForAccount'], u'length': 255, u'type': u'string', u'description': u'Name of the account that is to be marked.'}, {u'name': u'zoneid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The Zone ID with which the account is to be marked.'}], u'requiredparams': [u'domainid', u'account', u'zoneid'], u'description': u'Marks a default zone for this account'}}, u'clean': {u'vmreservations': {u'name': u'cleanVMReservations', u'related': [], u'isasync': True, u'params': [], u'requiredparams': [], u'description': u'Cleanups VM reservations in the database.'}}, u'release': {u'publiciprange': {u'name': u'releasePublicIpRange', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listVlanIpRanges', u'dedicatePublicIpRange'], u'length': 255, u'type': u'uuid', u'description': u'the id of the Public IP range'}], u'requiredparams': [u'id'], u'description': u'Releases a Public IP range back to the system pool'}, u'hostreservation': {u'name': u'releaseHostReservation', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'addHost', u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the host ID'}], u'requiredparams': [u'id'], u'description': u'Releases host reservation.'}, u'dedicatedcluster': {u'name': u'releaseDedicatedCluster', u'related': [], u'isasync': True, u'params': [{u'name': u'clusterid', u'required': True, u'related': [u'updateCluster'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Cluster'}], u'requiredparams': [u'clusterid'], u'description': u'Release the dedication for cluster'}, u'dedicatedzone': {u'name': u'releaseDedicatedZone', u'related': [], u'isasync': True, u'params': [{u'name': u'zoneid', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Zone'}], u'requiredparams': [u'zoneid'], u'description': u'Release dedication of zone'}, u'dedicatedhost': {u'name': u'releaseDedicatedHost', u'related': [], u'isasync': True, u'params': [{u'name': u'hostid', u'required': True, u'related': [u'addHost', u'updateHost', u'addBaremetalHost', u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the host'}], u'requiredparams': [u'hostid'], u'description': u'Release the dedication for host'}, u'dedicatedpod': {u'name': u'releaseDedicatedPod', u'related': [], u'isasync': True, u'params': [{u'name': u'podid', u'required': True, u'related': [u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Pod'}], u'requiredparams': [u'podid'], u'description': u'Release the dedication for the pod'}, u'dedicatedguestvlanrange': {u'name': u'releaseDedicatedGuestVlanRange', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listDedicatedGuestVlanRanges', u'dedicateGuestVlanRange'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the dedicated guest vlan range'}], u'requiredparams': [u'id'], u'description': u'Releases a dedicated guest vlan range to the system'}}, u'assign': {u'togloballoadbalancerrule': {u'name': u'assignToGlobalLoadBalancerRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listGlobalLoadBalancerRules', u'updateGlobalLoadBalancerRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the global load balancer rule'}, {u'name': u'loadbalancerrulelist', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'list', u'description': u'the list load balancer rules that will be assigned to gloabal load balacner rule'}, {u'name': u'gslblbruleweightsmap', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u"Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'"}], u'requiredparams': [u'id', u'loadbalancerrulelist'], u'description': u'Assign load balancer rule or list of load balancer rules to a global load balancer rules.'}, u'toloadbalancerrule': {u'name': u'assignToLoadBalancerRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}, {u'name': u'virtualmachineids', u'required': True, u'related': [u'revertToVMSnapshot', u'changeServiceForVirtualMachine', u'detachIso', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'startVirtualMachine', u'destroyVirtualMachine', u'migrateVirtualMachine'], u'length': 255, u'type': u'list', u'description': u'the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)'}], u'requiredparams': [u'id', u'virtualmachineids'], u'description': u'Assigns virtual machine or a list of virtual machines to a load balancer rule.'}, u'virtualmachine': {u'name': u'assignVirtualMachine', u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'isasync': False, u'params': [{u'name': u'account', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'account name of the new VM owner.'}, {u'name': u'securitygroupids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.'}, {u'name': u'virtualmachineid', u'required': True, u'related': [u'revertToVMSnapshot', u'migrateVirtualMachineWithVolume', u'assignVirtualMachine', u'stopVirtualMachine', u'restoreVirtualMachine', u'updateVirtualMachine', u'listVirtualMachines', u'destroyVirtualMachine'], u'length': 255, u'type': u'uuid', u'description': u'id of the VM to be moved'}, {u'name': u'networkids', u'required': False, u'related': [u'updateNetwork'], u'length': 255, u'type': u'list', u'description': u'list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.'}, {u'name': u'domainid', u'required': True, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'domain id of the new VM owner.'}], u'requiredparams': [u'account', u'virtualmachineid', u'domainid'], u'description': u'Assign a VM from one account to another under the same domain. This API is available for Basic zones with security groups and Advance zones with guest networks. The VM is restricted to move between accounts under same domain.'}}, u'delete': {u'loadbalancerrule': {u'name': u'deleteLoadBalancerRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer rule'}], u'requiredparams': [u'id'], u'description': u'Deletes a load balancer rule.'}, u'domain': {u'name': u'deleteDomain', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain', u'createDomain'], u'length': 255, u'type': u'uuid', u'description': u'ID of domain to delete'}, {u'name': u'cleanup', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise'}], u'requiredparams': [u'id'], u'description': u'Deletes a specified domain'}, u'projectinvitation': {u'name': u'deleteProjectInvitation', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'id of the invitation'}], u'requiredparams': [u'id'], u'description': u'Accepts or declines project invitation'}, u'diskoffering': {u'name': u'deleteDiskOffering', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'createDiskOffering'], u'length': 255, u'type': u'uuid', u'description': u'ID of the disk offering'}], u'requiredparams': [u'id'], u'description': u'Updates a disk offering.'}, u'securitygroup': {u'name': u'deleteSecurityGroup', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': False, u'related': [u'listSecurityGroups'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the security group. Mutually exclusive with name parameter'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account of the security group. Must be specified with domain ID'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID of account owning the security group'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'the project of the security group'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The ID of the security group. Mutually exclusive with id parameter'}], u'requiredparams': [], u'description': u'Deletes security group'}, u'portforwardingrule': {u'name': u'deletePortForwardingRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listIpForwardingRules'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the port forwarding rule'}], u'requiredparams': [u'id'], u'description': u'Deletes a port forwarding rule'}, u'cluster': {u'name': u'deleteCluster', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the cluster ID'}], u'requiredparams': [u'id'], u'description': u'Deletes a cluster.'}, u'accountfromproject': {u'name': u'deleteAccountFromProject', u'related': [], u'isasync': True, u'params': [{u'name': u'account', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'name of the account to be removed from the project'}, {u'name': u'projectid', u'required': True, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'id of the project to remove the account from'}], u'requiredparams': [u'account', u'projectid'], u'description': u'Deletes account from the project'}, u'networkdevice': {u'name': u'deleteNetworkDevice', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'addHost', u'updateHost', u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'Id of network device to delete'}], u'requiredparams': [u'id'], u'description': u'Deletes network device.'}, u'pod': {u'name': u'deletePod', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listPods', u'updatePod', u'createPod'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Pod'}], u'requiredparams': [u'id'], u'description': u'Deletes a Pod.'}, u'ipforwardingrule': {u'name': u'deleteIpForwardingRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'the id of the forwarding rule'}], u'requiredparams': [u'id'], u'description': u'Deletes an ip forwarding rule'}, u'secondarystagingstore': {u'name': u'deleteSecondaryStagingStore', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listSecondaryStagingStores', u'listSwifts', u'addS3', u'createSecondaryStagingStore', u'addImageStore'], u'length': 255, u'type': u'uuid', u'description': u'the staging store ID'}], u'requiredparams': [u'id'], u'description': u'Deletes a secondary staging store .'}, u'snapshotpolicies': {u'name': u'deleteSnapshotPolicies', u'related': [], u'isasync': False, u'params': [{u'name': u'ids', u'required': False, u'related': [u'createSnapshotPolicy'], u'length': 255, u'type': u'list', u'description': u'list of snapshots policy IDs separated by comma'}, {u'name': u'id', u'required': False, u'related': [u'createSnapshotPolicy'], u'length': 255, u'type': u'uuid', u'description': u'the Id of the snapshot policy'}], u'requiredparams': [], u'description': u'Deletes snapshot policies for the account.'}, u'vpcoffering': {u'name': u'deleteVPCOffering', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the VPC offering'}], u'requiredparams': [u'id'], u'description': u'Deletes VPC offering'}, u'network': {u'name': u'deleteNetwork', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateNetwork'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network'}], u'requiredparams': [u'id'], u'description': u'Deletes a network'}, u'zone': {u'name': u'deleteZone', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Zone'}], u'requiredparams': [u'id'], u'description': u'Deletes a Zone.'}, u'remoteaccessvpn': {u'name': u'deleteRemoteAccessVpn', u'related': [], u'isasync': True, u'params': [{u'name': u'publicipid', u'required': True, u'related': [u'associateIpAddress'], u'length': 255, u'type': u'uuid', u'description': u'public ip address id of the vpn server'}], u'requiredparams': [u'publicipid'], u'description': u'Destroys a l2tp/ipsec remote access vpn'}, u'alerts': {u'name': u'deleteAlerts', u'related': [], u'isasync': False, u'params': [{u'name': u'startdate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'start date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'delete by alert type'}, {u'name': u'enddate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'end date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}, {u'name': u'ids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the IDs of the alerts'}], u'requiredparams': [], u'description': u'Delete one or more alerts.'}, u'autoscalepolicy': {u'name': u'deleteAutoScalePolicy', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateAutoScalePolicy', u'createAutoScalePolicy'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale policy'}], u'requiredparams': [u'id'], u'description': u'Deletes a autoscale policy.'}, u'globalloadbalancerrule': {u'name': u'deleteGlobalLoadBalancerRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listGlobalLoadBalancerRules', u'updateGlobalLoadBalancerRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the global load balancer rule'}], u'requiredparams': [u'id'], u'description': u'Deletes a global load balancer rule.'}, u'portableiprange': {u'name': u'deletePortableIpRange', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listPortableIpRanges'], u'length': 255, u'type': u'uuid', u'description': u'Id of the portable ip range'}], u'requiredparams': [u'id'], u'description': u"deletes a range of portable public IP's associated with a region"}, u'serviceoffering': {u'name': u'deleteServiceOffering', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listServiceOfferings'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the service offering'}], u'requiredparams': [u'id'], u'description': u'Deletes a service offering.'}, u'template': {u'name': u'deleteTemplate', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateTemplate', u'registerTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the template'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of zone of the template'}], u'requiredparams': [u'id'], u'description': u'Deletes a template from the system. All virtual machines using the deleted template will not be affected.'}, u'vpngateway': {u'name': u'deleteVpnGateway', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createVpnGateway'], u'length': 255, u'type': u'uuid', u'description': u'id of customer gateway'}], u'requiredparams': [u'id'], u'description': u'Delete site to site vpn gateway'}, u'iso': {u'name': u'deleteIso', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateTemplate', u'registerTemplate', u'registerIso', u'listIsos', u'updateIso', u'listTemplates', u'copyIso', u'prepareTemplate'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the ISO file'}, {u'name': u'zoneid', u'required': False, u'related': [u'updateZone', u'createZone', u'listZones'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones'}], u'requiredparams': [u'id'], u'description': u'Deletes an ISO file.'}, u'networkacllist': {u'name': u'deleteNetworkACLList', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network ACL'}], u'requiredparams': [u'id'], u'description': u'Deletes a Network ACL'}, u'events': {u'name': u'deleteEvents', u'related': [], u'isasync': False, u'params': [{u'name': u'ids', u'required': False, u'related': [], u'length': 255, u'type': u'list', u'description': u'the IDs of the events'}, {u'name': u'type', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'delete by event type'}, {u'name': u'startdate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'start date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}, {u'name': u'enddate', u'required': False, u'related': [], u'length': 255, u'type': u'date', u'description': u'end date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")'}], u'requiredparams': [], u'description': u'Delete one or more events.'}, u'autoscalevmgroup': {u'name': u'deleteAutoScaleVmGroup', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'disableAutoScaleVmGroup', u'enableAutoScaleVmGroup', u'updateAutoScaleVmGroup'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale group'}], u'requiredparams': [u'id'], u'description': u'Deletes a autoscale vm group.'}, u'vpnconnection': {u'name': u'deleteVpnConnection', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listVpnConnections', u'resetVpnConnection'], u'length': 255, u'type': u'uuid', u'description': u'id of vpn connection'}], u'requiredparams': [u'id'], u'description': u'Delete site to site vpn connection'}, u'trafficmonitor': {u'name': u'deleteTrafficMonitor', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listHosts', u'prepareHostForMaintenance'], u'length': 255, u'type': u'uuid', u'description': u'Id of the Traffic Monitor Host.'}], u'requiredparams': [u'id'], u'description': u'Deletes an traffic monitor host.'}, u'networkacl': {u'name': u'deleteNetworkACL', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createNetworkACL'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network ACL'}], u'requiredparams': [u'id'], u'description': u'Deletes a Network ACL'}, u'storagepool': {u'name': u'deleteStoragePool', u'related': [], u'isasync': False, u'params': [{u'name': u'forced', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)'}, {u'name': u'id', u'required': True, u'related': [u'findStoragePoolsForMigration'], u'length': 255, u'type': u'uuid', u'description': u'Storage pool id'}], u'requiredparams': [u'id'], u'description': u'Deletes a storage pool.'}, u'vmsnapshot': {u'name': u'deleteVMSnapshot', u'related': [], u'isasync': True, u'params': [{u'name': u'vmsnapshotid', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The ID of the VM snapshot'}], u'requiredparams': [u'vmsnapshotid'], u'description': u'Deletes a vmsnapshot.'}, u'tags': {u'name': u'deleteTags', u'related': [], u'isasync': True, u'params': [{u'name': u'resourcetype', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Delete tag by resource type'}, {u'name': u'tags', u'required': False, u'related': [], u'length': 255, u'type': u'map', u'description': u'Delete tags matching key/value pairs'}, {u'name': u'resourceids', u'required': True, u'related': [], u'length': 255, u'type': u'list', u'description': u'Delete tags for resource id(s)'}], u'requiredparams': [u'resourcetype', u'resourceids'], u'description': u'Deleting resource tag(s)'}, u'lbstickinesspolicy': {u'name': u'deleteLBStickinessPolicy', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createLBStickinessPolicy'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the LB stickiness policy'}], u'requiredparams': [u'id'], u'description': u'Deletes a LB stickiness policy.'}, u'staticroute': {u'name': u'deleteStaticRoute', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listStaticRoutes', u'createStaticRoute'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the static route'}], u'requiredparams': [u'id'], u'description': u'Deletes a static route'}, u'traffictype': {u'name': u'deleteTrafficType', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'addTrafficType'], u'length': 255, u'type': u'uuid', u'description': u'traffic type id'}], u'requiredparams': [u'id'], u'description': u'Deletes traffic type of a physical network'}, u'host': {u'name': u'deleteHost', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the host ID'}, {u'name': u'forced', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped'}, {u'name': u'forcedestroylocalstorage', u'required': False, u'related': [], u'length': 255, u'type': u'boolean', u'description': u'Force destroy local storage on this host. All VMs created on this local storage will be destroyed'}], u'requiredparams': [u'id'], u'description': u'Deletes a host.'}, u'user': {u'name': u'deleteUser', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listUsers', u'updateUser', u'lockUser', u'getUser', u'disableUser'], u'length': 255, u'type': u'uuid', u'description': u'id of the user to be deleted'}], u'requiredparams': [u'id'], u'description': u'Deletes a user for an account'}, u'vpc': {u'name': u'deleteVPC', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'restartVPC', u'createVPC', u'listVPCs'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the VPC'}], u'requiredparams': [u'id'], u'description': u'Deletes a VPC'}, u'storagenetworkiprange': {u'name': u'deleteStorageNetworkIpRange', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listStorageNetworkIpRange', u'createStorageNetworkIpRange', u'updateStorageNetworkIpRange'], u'length': 255, u'type': u'uuid', u'description': u'the uuid of the storage network ip range'}], u'requiredparams': [u'id'], u'description': u'Deletes a storage network IP Range.'}, u'condition': {u'name': u'deleteCondition', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listConditions'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the condition.'}], u'requiredparams': [u'id'], u'description': u'Removes a condition'}, u'autoscalevmprofile': {u'name': u'deleteAutoScaleVmProfile', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listAutoScaleVmProfiles'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the autoscale profile'}], u'requiredparams': [u'id'], u'description': u'Deletes a autoscale vm profile.'}, u'affinitygroup': {u'name': u'deleteAffinityGroup', u'related': [], u'isasync': True, u'params': [{u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account of the affinity group. Must be specified with domain ID'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID of account owning the affinity group'}, {u'name': u'name', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'The name of the affinity group. Mutually exclusive with id parameter'}, {u'name': u'id', u'required': False, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'The ID of the affinity group. Mutually exclusive with name parameter'}], u'requiredparams': [], u'description': u'Deletes affinity group'}, u'volume': {u'name': u'deleteVolume', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'createVolume', u'uploadVolume'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the disk volume'}], u'requiredparams': [u'id'], u'description': u'Deletes a detached disk volume.'}, u'account': {u'name': u'deleteAccount', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listAccounts', u'disableAccount', u'markDefaultZoneForAccount'], u'length': 255, u'type': u'uuid', u'description': u'Account id'}], u'requiredparams': [u'id'], u'description': u'Deletes a account, and all users associated with this account'}, u'instancegroup': {u'name': u'deleteInstanceGroup', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the instance group'}], u'requiredparams': [u'id'], u'description': u'Deletes a vm group'}, u'firewallrule': {u'name': u'deleteFirewallRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the firewall rule'}], u'requiredparams': [u'id'], u'description': u'Deletes a firewall rule'}, u'networkoffering': {u'name': u'deleteNetworkOffering', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateNetworkOffering', u'createNetworkOffering'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network offering'}], u'requiredparams': [u'id'], u'description': u'Deletes a network offering.'}, u'vpncustomergateway': {u'name': u'deleteVpnCustomerGateway', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'listVpnCustomerGateways', u'updateVpnCustomerGateway'], u'length': 255, u'type': u'uuid', u'description': u'id of customer gateway'}], u'requiredparams': [u'id'], u'description': u'Delete site to site vpn customer gateway'}, u'counter': {u'name': u'deleteCounter', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createCounter'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the counter'}], u'requiredparams': [u'id'], u'description': u'Deletes a counter'}, u'lbhealthcheckpolicy': {u'name': u'deleteLBHealthCheckPolicy', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createLBHealthCheckPolicy', u'listLBHealthCheckPolicies'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the load balancer HealthCheck policy'}], u'requiredparams': [u'id'], u'description': u'Deletes a load balancer HealthCheck policy.'}, u'project': {u'name': u'deleteProject', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'updateProject', u'createProject', u'listProjectAccounts', u'activateProject'], u'length': 255, u'type': u'uuid', u'description': u'id of the project to be deleted'}], u'requiredparams': [u'id'], u'description': u'Deletes a project'}, u'vlaniprange': {u'name': u'deleteVlanIpRange', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [u'listVlanIpRanges', u'dedicatePublicIpRange'], u'length': 255, u'type': u'uuid', u'description': u'the id of the VLAN IP range'}], u'requiredparams': [u'id'], u'description': u'Creates a VLAN IP range.'}, u'snapshot': {u'name': u'deleteSnapshot', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createSnapshot'], u'length': 255, u'type': u'uuid', u'description': u'The ID of the snapshot'}], u'requiredparams': [u'id'], u'description': u'Deletes a snapshot of a disk volume.'}, u'loadbalancer': {u'name': u'deleteLoadBalancer', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Load Balancer'}], u'requiredparams': [u'id'], u'description': u'Deletes a load balancer'}, u'imagestore': {u'name': u'deleteImageStore', u'related': [], u'isasync': False, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the image store ID'}], u'requiredparams': [u'id'], u'description': u'Deletes an image store .'}, u'egressfirewallrule': {u'name': u'deleteEgressFirewallRule', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createPortForwardingRule', u'listPortForwardingRules', u'listIpForwardingRules', u'createIpForwardingRule', u'updatePortForwardingRule'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the firewall rule'}], u'requiredparams': [u'id'], u'description': u'Deletes an ggress firewall rule'}, u'networkserviceprovider': {u'name': u'deleteNetworkServiceProvider', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'addNetworkServiceProvider', u'updateNetworkServiceProvider', u'listTrafficTypes'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the network service provider'}], u'requiredparams': [u'id'], u'description': u'Deletes a Network Service Provider.'}, u'physicalnetwork': {u'name': u'deletePhysicalNetwork', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [], u'length': 255, u'type': u'uuid', u'description': u'the ID of the Physical network'}], u'requiredparams': [u'id'], u'description': u'Deletes a Physical Network.'}, u'sshkeypair': {u'name': u'deleteSSHKeyPair', u'related': [], u'isasync': False, u'params': [{u'name': u'name', u'required': True, u'related': [], u'length': 255, u'type': u'string', u'description': u'Name of the keypair'}, {u'name': u'account', u'required': False, u'related': [], u'length': 255, u'type': u'string', u'description': u'the account associated with the keypair. Must be used with the domainId parameter.'}, {u'name': u'projectid', u'required': False, u'related': [u'updateProject', u'createProject'], u'length': 255, u'type': u'uuid', u'description': u'the project associated with keypair'}, {u'name': u'domainid', u'required': False, u'related': [u'listDomainChildren', u'listDomains', u'updateDomain'], u'length': 255, u'type': u'uuid', u'description': u'the domain ID associated with the keypair'}], u'requiredparams': [u'name'], u'description': u'Deletes a keypair by name'}, u'privategateway': {u'name': u'deletePrivateGateway', u'related': [], u'isasync': True, u'params': [{u'name': u'id', u'required': True, u'related': [u'createPrivateGateway'], u'length': 255, u'type': u'uuid', u'description': u'the ID of the private gateway'}], u'requiredparams': [u'id'], u'description': u'Deletes a Private gateway'}}}