CloudProviderFramework Module

None

class CloudProviderFramework.BlobInfo

class BlobInfo properties:

Name	Description
finished	If true, copying is done.
name	Name of this blob.
progress	Copy progress of this blob.

class CloudProviderFramework.CloudConnectorConfig

class CloudConnectorConfig properties:

Name	Description
cloud_provider	Provider name used by this connector.
login_domain	If set, created VMs will join this domain.
login_user	User for SMB connections and domain joining.
name	Name of this connector.
provider_config	Provider config used by this connector.
vm_admin_ssh_key	SSH key used for all created VMs.
vm_admin_username	Adminstrator user used for all created VMs.
vm_image_name	Name of the image that will be used to create cloud VMs.
vm_image_os	Which OS is installed on the template image. Can be eiter ‘Windows’ or ‘Linux’
vm_low_prio	If enabled and available, the VM will be created as low priority machine.
vm_low_prio_max_price	If the current price goes above this limit the VM will be deallocated. Requires ‘vm_low_prio’ to be ‘True’.
vm_size	The size type (Cores, Ram, Disk, etc.) of the created VMs.
vm_storage	Name of the storage that should be used to save the VMs’ disk images.
vm_storage_sas_token	Storage authentication token.

class CloudProviderFramework.CloudProviderConfig

class CloudProviderConfig properties:

Name	Description
admin_username	Admin username for cloud provider.
clientsPerStorage	Max number of clients that will be created in a storage.
cloud_location	Default cloud location.
domain_admin	Domain admin user used to join the domain.
domain_ou	The domain’s organizational unit.
domain_url	URL of the to domain that should be joined.
manager_ip	IP address of the machine that runs rrCloudManager.
name	Name of this cloud provider.
rr_path	Path to your Royal Render root directory.
share_host	Hostname of local share (render data server).
share_ip	IP address of local share (render data server).
storages_per_group	Max number of storages that will be created in a resource group.
subscriber_id	Subscriber ID for cloud provider.
tenant_id	Tenant ID for cloud provider.
use_auto_vpn	OpenVPN creation will be handled automatically.
vn_name	Name of the Virtual Network in the cloud.
vn_render_subnet	Subnet for all render clients. In CIDR notation.
vn_resource_group	Name of the resource group in which the Virtual Network resides.
vn_subnet	Subnet range for Virtual Network. In CIDR notation.
vn_subnet_name	Subnet name for Virtual Network.In CIDR notation.
vn_vpn_client_subnet	Subnet for all OpenVPN clients. In CIDR notation.
vn_vpn_local_network	Local network RR is used in. In CIDR notation.
vn_vpn_username	Admin username for OpenVPN server VM.
vn_vpn_vm_size	The size type (Cores, Ram, Disk, etc.) of the created VMs.
vpn_tap_device_name	Name of the TAP device used by your OpenVPN client.

class CloudProviderFramework.CopyBlobResponse

Bases: CloudProviderFramework.RestResponse

class CopyBlobResponse properties:

Name	Description
storageName	Current storage name.

class CloudProviderFramework.CreateResourceGroupResponse

Bases: CloudProviderFramework.RestResponse

class CreateResourceGroupResponse properties:

Name	Description
resource_group_name	Name of resource group that should be created.

class CloudProviderFramework.CreateStorageResponse

class CreateStorageResponse properties:

Name	Description
storage_name	Name of storage that should be created.

class CloudProviderFramework.CreateVMsResponse

Bases: CloudProviderFramework.RestResponse

class CreateVMsResponse properties:

Name	Description
vm_names	List of VM names.

class CloudProviderFramework.DeleteNicResponse

Bases: CloudProviderFramework.RestResponse

class DeleteNicResponse properties:

Name	Description
vm_name	Name of NIC that should be deleted.

class CloudProviderFramework.DeleteResourceGroupResponse

Bases: CloudProviderFramework.RestResponse

class DeleteResourceGroupResponse properties:

Name	Description
resource_group_name	Name of resource group that should be deleted.

class CloudProviderFramework.DeleteVMResponse

Bases: CloudProviderFramework.RestResponse

class DeleteVMResponse properties:

Name	Description
vm_name	Name of VM that should be deleted.

class CloudProviderFramework.DeploymentInfoResponse

Bases: CloudProviderFramework.RestResponse

class DeploymentInfoResponse properties:

Name	Description
code	Error code of this deployment.
message	Error message of this deployment.
provisioning_state	Current provisioning state of this deployment.
resource_group	Resource group this deployment belongs to.
timestamp	Timestamp of this deployment.

class CloudProviderFramework.InstanceResponse

Bases: CloudProviderFramework.RestResponse

class InstanceResponse properties:

Name	Description
power_state	Power state of this VM.
power_state_string	Power state as string.
system_state	System state of this VM.
system_state_string	System state as string.
vm_name	Name of this VM.

class CloudProviderFramework.ListBlobsResponse

Bases: CloudProviderFramework.RestResponse

class ListBlobsResponse properties:

Name	Description
blob_info_map	Dictionary of BlobInfos.
container_name	Name of current container.
marker	Current marker.
next_marker	Next marker.
storage_name	Name of current storage.

class CloudProviderFramework.ListComputeImagesResponse

Bases: CloudProviderFramework.RestResponse

class ListComputeImagesResponse properties:

Name	Description
image_names	List of image names.
resource_group_name	Current resource group name.
storage_name	Current storage name.

class CloudProviderFramework.ListLocationsResponse

Bases: CloudProviderFramework.RestResponse

class ListLocationsResponse properties:

Name	Description
locations	List of locations.

class CloudProviderFramework.ListResourceGroupsResponse

Bases: CloudProviderFramework.RestResponse

class ListResourceGroupsResponse properties:

Name	Description
resource_group_names	List of resource groups.

class CloudProviderFramework.ListScaleSetsResponse

Bases: CloudProviderFramework.RestResponse

class ListScaleSetsResponse properties:

Name	Description
resource_group_name	Current resource group.
scale_sets	List of scale sets names.

class CloudProviderFramework.ListSkusResponse

Bases: CloudProviderFramework.RestResponse

class ListSkusResponse properties:

Name	Description
provider_name	Name of current provider.
sku_info_map	Dictionary of SKUs.

class CloudProviderFramework.ListStorageContainersResponse

Bases: CloudProviderFramework.RestResponse

class ListStorageContainersResponse properties:

Name	Description
container_names	List of container names.
storage_name	Name of the storage.

class CloudProviderFramework.ListVmImagesResponse

Bases: CloudProviderFramework.RestResponse

class ListVmImagesResponse properties:

Name	Description
images	List of VmImageInfo

class CloudProviderFramework.ListVmPricesResponse

Bases: CloudProviderFramework.RestResponse

class ListVmPricesResponse properties:

Name	Description
provider_name	Name of current provider.
vm_prices	List of VmPrices.

class CloudProviderFramework.NetworkInterfacesResponse

Bases: CloudProviderFramework.RestResponse

class NetworkInterfacesResponse properties:

Name	Description
nic_info_map	Dictionary of NicInfos.

class CloudProviderFramework.NicInfo

class NicInfo properties:

Name	Description
ip_address	Private IP address of this interface.
ip_address_public	Public IP address of this interface.
nic_name	Network interface name.

class CloudProviderFramework.PluginInstance

class CloudProviderFramework.ProviderPlugin

class ProviderPlugin functions:

Return Type	Name	Description
	add_vms_finished(CreateVMsResponse)
	capture_image_from_vm_finished(RestResponse)
str	client_id()
	create_resource_group_finished(CreateResourceGroupResponse)
	create_storage_finished(CreateStorageResponse)
	create_virtual_network_finished(RestResponse)
	delete_deployment_finished(RestResponse)
	delete_nic_finished(DeleteNicResponse)
	delete_resource_group_finished(DeleteResourceGroupResponse)
	delete_vm_finished(DeleteVMResponse)
	generalize_vm_finished(RestResponse)
	get_deployment_info_finished(DeploymentInfoResponse)
	get_resource_group_info_finished(RestResponse)
	get_vm_info_finished(InstanceResponse)
	list_locations_finished(ListLocationsResponse)
	list_nics_finished(NetworkInterfacesResponse)
	list_resource_groups_finished(ListResourceGroupsResponse)
	list_skus_finished(ListSkusResponse)
	list_vm_images_finished(ListVmImagesResponse)
	list_vm_prices_finished(ListVmPricesResponse)
	list_vm_sizes_finished(VmSizesResponse)
	list_vms_finished(VirtualMachinesResponse)
str	location()
str	name()
str	password()
	request_storage_keys_finished(StorageKeyResponse)
	set_error(str)
	shutdown_vms_finished(VirtualMachineNameResponse)
	start_vms_finished(VirtualMachineNameResponse)
str	subscriber_id()
str	tenant_id()
str	username()

class CloudProviderFramework.RestPowerState

0	PS_None
1	PS_Unknown
2	PS_CreatingVM
3	PS_StartingVM
4	PS_CreatingRole
5	PS_StartingRole
6	PS_ReadyRole
7	PS_WaitingForStartTask
8	PS_BusyRole
9	PS_StoppingRole
10	PS_StoppingVM
11	PS_DeletingVM
12	PS_StoppedVM
13	PS_RestartingRole
14	PS_CyclingRole
15	PS_FailedStartingRole
16	PS_UnresponsiveRole
17	PS_StoppedDeallocated
18	PS_Preparing
19	PS_Deallocating
20	PS_LeavingPool
21	PS_Generalized

class CloudProviderFramework.RestResponse

class RestResponse functions:

Return Type	Name	Description
	set_context(str)
	set_details_code(str)
	set_details_message(str)
	set_error_code(str)
	set_error_message(str)

class CloudProviderFramework.SkuInfo

class SkuInfo properties:

Name	Description
allows_ephemeral_os_disk	Allows the use of ephemeral disks (local only).
allows_low_priority	Allows to be run as low priority VM.
has_premium_io	Uses a premium disk plan.
memory_size	Size of the memory in GB.
name	Name of the SKU.
number_of_cores	Size of the memory in GB
os_disk_size	Size of the OS disk in GB.

class CloudProviderFramework.StorageKeyResponse

Bases: CloudProviderFramework.RestResponse

class StorageKeyResponse properties:

Name	Description
key_1	First key.
key_2	Second key.
resource_group_name	Name of the resource group.
storage_name	Name of the storage.

class CloudProviderFramework.Type

0	T_Windows
1	T_Linux

class CloudProviderFramework.UsageResponse

Bases: CloudProviderFramework.RestResponse

class UsageResponse properties:

Name	Description
usage_json	Usage data (json formatted).

class CloudProviderFramework.VirtualMachineNameResponse

Bases: CloudProviderFramework.RestResponse

class CloudProviderFramework.VirtualMachinesResponse

Bases: CloudProviderFramework.RestResponse

class VirtualMachinesResponse properties:

Name	Description
resource_group_name	Current resource group name.
vm_info_map	Dictionary of VmInfos.

class CloudProviderFramework.VirtualNetworkConfig

class VirtualNetworkConfig properties:

Name	Description
location	Cloud location for this Virtual Network.
name	Name of this Virtual Network.
render_subnet	Subnet for all render clients. In CIDR notation.
resource_group_name	Resource group name this VN will be created in.
subnet	Subnet range of this Virtual Network. In CIDR notation.
vpn_client_subnet	Subnet for all OpenVPN clients. In CIDR notation.
vpn_image_name	Name of the image that will be used to create the OpenVPN server VM.
vpn_local_network	Local network RR is used in. In CIDR notation.
vpn_password	Admin password for OpenVPN server VM.
vpn_server_ip	IP address of OpenVPN server VM.
vpn_ssh_keyfile	Admin SSH key file.
vpn_subnet	If true, an OpenVpn server will be automatically created and configured.
vpn_username	Admin username for OpenVPN server VM.
vpn_vm_size	The size type (Cores, Ram, Disk, etc.) of the created OpenVPN server VM.

class CloudProviderFramework.VmConfig

class VmConfig properties:

Name	Description
cloud_connector_config	Cloud connector config that is associated with this VM.
enable_automatic_updates	If true, VM will be updated automatically.
resource_group_name	Resource group this VM will be created in.
storage_name	Name of the storage for this VM’s disk image.
subnet	Render subnet name.
virtual_network_name	Name of the Virtual Network this VM belongs to.
virtual_network_resource_group	Resource group of the Virtual Network.

class CloudProviderFramework.VmImageInfo

class VmImageInfo properties:

Name	Description
id	ID of this image.
name	Name of this image.
planName	Name of this image plan.
planProduct	Product name of this image plan.
planPublisher	Publisher of this image plan.

class CloudProviderFramework.VmInfo

class VmInfo properties:

Name	Description
ip_address	IP address of this VM.
power_state	Power state of this VM.
role_name	Name of the VM.
system_state	System state of this VM.

class CloudProviderFramework.VmPriceInfo

class VmPriceInfo properties:

Name	Description
currency_code	Code of the pricing currency.
discount	Discount for this VM.
meter_name	Meter name of VM.
product_name	Product name of VM.
region	Region this price info is for.
retail_price	Retail price for this VM.
sku_id	SKU ID of the VM.
sku_name	SKU name of VM.
unit_of_measure	Unit of measure, e.g. 1 Hour
unit_price	Unit price for this VM.

class CloudProviderFramework.VmSizesResponse

Bases: CloudProviderFramework.RestResponse

class VmSizesResponse properties:

Name	Description
vm_sizes	List of VM size names.