C# Class Austin.Linode.LinodeClient

Datei anzeigen Open project: AustinWise/Austin.Linode Class Usage Examples

Public Properties

Property	Type	Description
GeneratedApiVersion	System.Version

Public Methods

Method	Description
Account_EstimateInvoice ( string mode, int LinodeID = null, int PaymentTerm = null, int PlanID = null ) : void	Estimates the invoice for adding a new Linode or NodeBalancer as well as resizing a Linode. This returns two fields: PRICE which is the estimated cost of the invoice, and INVOICE_TO which is the date invoice would be though with timezone set to America/New_York
Account_Info ( ) : void	Shows information about your account such as the date your account was opened as well as your network utilization for the current month in gigabytes.
Account_PayBalance ( ) : void	Pays current balance on file, returning it in the response.
Account_UpdateCard ( int ccExpMonth, int ccExpYear, int ccNumber ) : void
Avail_Datacenters ( ) : Austin.Linode.DataCenter[]	Returns a list of Linode data center facilities.
Avail_Distributions ( int DistributionID = null ) : void	Returns a list of available Linux Distributions.
Avail_Kernels ( bool isKVM = null, bool isXen = null ) : void	List available kernels.
Avail_LinodePlans ( int PlanID = null ) : Austin.Linode.Plan[]	Returns a structure of Linode PlanIDs containing the Plan label and the availability in each Datacenter.
Avail_NodeBalancers ( ) : void	Returns NodeBalancer pricing information.
Avail_StackScripts ( int DistributionID = null, string DistributionVendor = null, string keywords = null ) : void	Returns a list of available public StackScripts.
Domain_Create ( string Domain, string Type, string axfr_ips = null, string Description = null, int Expire_sec = null, string lpm_displayGroup = null, string master_ips = null, int Refresh_sec = null, int Retry_sec = null, string SOA_Email = null, int status = null, int TTL_sec = null ) : void	Create a domain record.
Domain_Delete ( int DomainID ) : void
Domain_List ( int DomainID = null ) : void	Lists domains you have access to.
Domain_Resource_Create ( int DomainID, string Type, string Name = null, int Port = null, int Priority = null, string Protocol = null, string Target = null, int TTL_sec = null, int Weight = null ) : void	Create a domain record.
Domain_Resource_Delete ( int DomainID, int ResourceID ) : void
Domain_Resource_List ( int DomainID, int ResourceID = null ) : void
Domain_Resource_Update ( int ResourceID, int DomainID = null, string Name = null, int Port = null, int Priority = null, string Protocol = null, string Target = null, int TTL_sec = null, int Weight = null ) : void	Update a domain record.
Domain_Update ( int DomainID, string axfr_ips = null, string Description = null, string Domain = null, int Expire_sec = null, string lpm_displayGroup = null, string master_ips = null, int Refresh_sec = null, int Retry_sec = null, string SOA_Email = null, int status = null, int TTL_sec = null, string Type = null ) : void	Update a domain record.
Image_Delete ( int ImageID ) : void	Deletes a gold-master image
Image_List ( int ImageID = null, int pending = null ) : void	Lists available gold-master images
Image_Update ( int ImageID, string description = null, string label = null ) : void	Update an Image record.
Linode_Boot ( int LinodeID, int ConfigID = null ) : Austin.Linode.JobIdResponse	Issues a boot job for the provided ConfigID. If no ConfigID is provided boots the last used configuration profile, or the first configuration profile if this Linode has never been booted.
Linode_Clone ( int DatacenterID, int LinodeID, int PlanID, int PaymentTerm = null ) : Austin.Linode.LinodeIdResponse	Creates a new Linode, assigns you full privileges, and then clones the specified LinodeID to the new Linode. There is a limit of 5 active clone operations per source Linode. It is recommended that the source Linode be powered down during the clone.
Linode_Config_Create ( string DiskList, int KernelID, string Label, int LinodeID, string Comments = null, bool devtmpfs_automount = null, bool helper_depmod = null, bool helper_disableUpdateDB = null, bool helper_distro = null, bool helper_network = null, bool helper_xen = null, int RAMLimit = null, string RootDeviceCustom = null, int RootDeviceNum = null, bool RootDeviceRO = null, string RunLevel = null, string virt_mode = null ) : Austin.Linode.ConfigIdResponse	Creates a Linode Configuration Profile.
Linode_Config_Delete ( int ConfigID, int LinodeID ) : Austin.Linode.ConfigIdResponse	Deletes a Linode Configuration Profile.
Linode_Config_List ( int LinodeID, int ConfigID = null ) : void	Lists a Linode's Configuration Profiles.
Linode_Config_Update ( int ConfigID, string Comments = null, bool devtmpfs_automount = null, string DiskList = null, bool helper_depmod = null, bool helper_disableUpdateDB = null, bool helper_distro = null, bool helper_network = null, bool helper_xen = null, int KernelID = null, string Label = null, int LinodeID = null, int RAMLimit = null, string RootDeviceCustom = null, int RootDeviceNum = null, bool RootDeviceRO = null, string RunLevel = null, string virt_mode = null ) : Austin.Linode.ConfigIdResponse	Updates a Linode Configuration Profile.
Linode_Create ( int DatacenterID, int PlanID, int PaymentTerm = null ) : Austin.Linode.LinodeIdResponse	Creates a Linode and assigns you full privileges. There is a 250-linodes-per-hour limiter.
Linode_Delete ( int LinodeID, bool skipChecks = null ) : Austin.Linode.LinodeIdResponse	Immediately removes a Linode from your account and issues a pro-rated credit back to your account, if applicable. To prevent accidental deletes, this requires the Linode has no Disk images. You must first delete its disk images."
Linode_Disk_Create ( string Label, int LinodeID, int Size, string Type, bool isReadOnly = null ) : Austin.Linode.DiskIdResponse
Linode_Disk_CreateFromDistribution ( int DistributionID, string Label, int LinodeID, string rootPass, int Size, string rootSSHKey = null ) : Austin.Linode.DiskIdResponse
Linode_Disk_CreateFromImage ( int ImageID, int LinodeID, string Label = null, string rootPass = null, string rootSSHKey = null, int size = null ) : void	Creates a new disk from a previously imagized disk.
Linode_Disk_CreateFromStackScript ( int DistributionID, string Label, int LinodeID, string rootPass, int Size, int StackScriptID, string StackScriptUDFResponses, string rootSSHKey = null ) : Austin.Linode.DiskIdResponse
Linode_Disk_Delete ( int DiskID, int LinodeID ) : Austin.Linode.DiskIdResponse
Linode_Disk_Duplicate ( int DiskID, int LinodeID ) : Austin.Linode.DiskIdResponse	Performs a bit-for-bit copy of a disk image.
Linode_Disk_Imagize ( int DiskID, int LinodeID, string Description = null, string Label = null ) : void	Creates a gold-master image for future deployments
Linode_Disk_List ( int LinodeID, int DiskID = null ) : void	Status values are 1: Ready and 2: Being Deleted.
Linode_Disk_Resize ( int DiskID, int LinodeID, int size ) : Austin.Linode.DiskIdResponse
Linode_Disk_Update ( int DiskID, bool isReadOnly = null, string Label = null, int LinodeID = null ) : void
Linode_Ip_AddPrivate ( int LinodeID ) : Austin.Linode.IpAddressResponse	Assigns a Private IP to a Linode. Returns the IPAddressID that was added.
Linode_Ip_AddPublic ( int LinodeID ) : Austin.Linode.IpAddressResponse	Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress that was added.
Linode_Ip_List ( int IPAddressID = null, int LinodeID = null ) : Austin.Linode.IpAddressListEntry[]	Returns the IP addresses of all Linodes you have access to.
Linode_Ip_SetRDns ( string Hostname, int IPAddressID ) : void	Sets the rDNS name of a Public IP. Returns the IPAddressID and IPAddress that were updated.
Linode_Ip_Swap ( int IPAddressID, int toLinodeID = null, int withIPAddressID = null ) : void	Exchanges Public IP addresses between two Linodes within a Datacenter. The destination of the IP Address can be designated by either the toLinodeID or withIPAddressID parameter. Returns the resulting relationship of the Linode and IP Address parameters. When performing a one directional swap, the source is represented by the first of the two resultant array members.
Linode_Job_List ( int LinodeID, int JobID = null, bool pendingOnly = null ) : Austin.Linode.Job[]
Linode_Kvmify ( int LinodeID ) : void	Changes a Linode's hypervisor from Xen to KVM.
Linode_List ( int LinodeID = null ) : Austin.Linode.Node[]	Returns a list of all Linodes user has access or delete to, including some properties. Status values are -1: Being Created, 0: Brand New, 1: Running, and 2: Powered Off.
Linode_Mutate ( int LinodeID ) : void	Upgrades a Linode to its next generation.
Linode_Reboot ( int LinodeID, int ConfigID = null ) : Austin.Linode.JobIdResponse	Issues a shutdown, and then boot job for a given LinodeID.
Linode_Resize ( int LinodeID, int PlanID ) : void	Resizes a Linode from one plan to another. Immediately shuts the Linode down, charges/credits the account, and issue a migration to another host server.
Linode_Shutdown ( int LinodeID ) : Austin.Linode.JobIdResponse	Issues a shutdown job for a given LinodeID.
Linode_Update ( int LinodeID, bool Alert_bwin_enabled = null, int Alert_bwin_threshold = null, bool Alert_bwout_enabled = null, int Alert_bwout_threshold = null, bool Alert_bwquota_enabled = null, int Alert_bwquota_threshold = null, bool Alert_cpu_enabled = null, int Alert_cpu_threshold = null, bool Alert_diskio_enabled = null, int Alert_diskio_threshold = null, int backupWeeklyDay = null, int backupWindow = null, string Label = null, string lpm_displayGroup = null, bool ms_ssh_disabled = null, string ms_ssh_ip = null, int ms_ssh_port = null, string ms_ssh_user = null, bool watchdog = null ) : Austin.Linode.LinodeIdResponse	Updates a Linode's properties.
Linode_WebConsoleToken ( int LinodeID ) : void	Generates a console token starting a web console LISH session for the requesting IP
NodeBalancer_Config_Create ( int NodeBalancerID, string Algorithm = null, string check = null, string check_attempts = null, string check_body = null, int check_interval = null, bool check_passive = null, string check_path = null, string check_timeout = null, string cipher_suite = null, int Port = null, string Protocol = null, string ssl_cert = null, string ssl_key = null, string Stickiness = null ) : void
NodeBalancer_Config_Delete ( int ConfigID, int NodeBalancerID ) : void	Deletes a NodeBalancer's Config
NodeBalancer_Config_List ( int NodeBalancerID, int ConfigID = null ) : void	Returns a list of NodeBalancers this user has access or delete to, including their properties
NodeBalancer_Config_Update ( int ConfigID, string Algorithm = null, string check = null, string check_attempts = null, string check_body = null, int check_interval = null, bool check_passive = null, string check_path = null, string check_timeout = null, string cipher_suite = null, int Port = null, string Protocol = null, string ssl_cert = null, string ssl_key = null, string Stickiness = null ) : void	Updates a Config's properties
NodeBalancer_Create ( int DatacenterID, int ClientConnThrottle = null, string Label = null ) : void
NodeBalancer_Delete ( int NodeBalancerID ) : void	Immediately removes a NodeBalancer from your account and issues a pro-rated credit back to your account, if applicable.
NodeBalancer_List ( int NodeBalancerID = null ) : void	Returns a list of NodeBalancers this user has access or delete to, including their properties
NodeBalancer_Node_Create ( string Address, int ConfigID, string Label, string Mode = null, int Weight = null ) : void
NodeBalancer_Node_Delete ( int NodeID ) : void	Deletes a Node from a NodeBalancer Config
NodeBalancer_Node_List ( int ConfigID, int NodeID = null ) : void	Returns a list of Nodes associated with a NodeBalancer Config
NodeBalancer_Node_Update ( int NodeID, string Address = null, string Label = null, string Mode = null, int Weight = null ) : void	Updates a Node's properties
NodeBalancer_Update ( int NodeBalancerID, int ClientConnThrottle = null, string Label = null ) : void	Updates a NodeBalancer's properties
StackScript_Create ( string DistributionIDList, string Label, string script, string Description = null, bool isPublic = null, string rev_note = null ) : void	Create a StackScript.
StackScript_Delete ( int StackScriptID ) : void
StackScript_List ( int StackScriptID = null ) : void	Lists StackScripts you have access to.
StackScript_Update ( int StackScriptID, string Description = null, string DistributionIDList = null, bool isPublic = null, string Label = null, string rev_note = null, string script = null ) : void	Update a StackScript.
Test_Echo ( ) : void	Echos back parameters that were passed in.
User_GetApiKey ( string password, string username, int expires = null, string label = null, string token = null ) : void	Authenticates a Linode Manager user against their username, password, and two-factor token (when enabled), and then returns a new API key, which can be used until it expires. The number of active keys is limited to 20. Batch requests will be rejected if they include this API action.

Method Details

Account_EstimateInvoice() public method

Estimates the invoice for adding a new Linode or NodeBalancer as well as resizing a Linode. This returns two fields: PRICE which is the estimated cost of the invoice, and INVOICE_TO which is the date invoice would be though with timezone set to America/New_York

possible errors: VALIDATION

public Account_EstimateInvoice ( string mode, int LinodeID = null, int PaymentTerm = null, int PlanID = null ) : void
mode	string	This is one of the following options: 'linode_new', 'linode_resize', or 'nodebalancer_new'.
LinodeID	int	This is the LinodeID you want to resize and is required for mode 'linode_resize'.
PaymentTerm	int	Subscription term in months. One of: 1, 12, or 24. This is required for modes 'linode_new' and 'nodebalancer_new'.
PlanID	int	The desired PlanID available from avail.LinodePlans(). This is required for modes 'linode_new' and 'linode_resize'.
return	void

Account_Info() public method

Shows information about your account such as the date your account was opened as well as your network utilization for the current month in gigabytes.

public Account_Info ( ) : void
return	void

Account_PayBalance() public method

Pays current balance on file, returning it in the response.

possible errors: CCEXPIRED,CCFAILED,NOACCESS,PAYMENTLIMITER,VALIDATION

public Account_PayBalance ( ) : void
return	void

Account_UpdateCard() public method

public Account_UpdateCard ( int ccExpMonth, int ccExpYear, int ccNumber ) : void
ccExpMonth	int
ccExpYear	int
ccNumber	int
return	void

Avail_Datacenters() public method

Returns a list of Linode data center facilities.

public Avail_Datacenters ( ) : Austin.Linode.DataCenter[]
return	Austin.Linode.DataCenter[]

Avail_Distributions() public method

Returns a list of available Linux Distributions.

public Avail_Distributions ( int DistributionID = null ) : void
DistributionID	int	Limits the results to the specified DistributionID
return	void

Avail_Kernels() public method

List available kernels.

public Avail_Kernels ( bool isKVM = null, bool isXen = null ) : void
isKVM	bool	Show or hide KVM compatible kernels
isXen	bool	Show or hide Xen compatible kernels
return	void

Avail_LinodePlans() public method

Returns a structure of Linode PlanIDs containing the Plan label and the availability in each Datacenter.

public Avail_LinodePlans ( int PlanID = null ) : Austin.Linode.Plan[]
PlanID	int	Limits the list to the specified PlanID
return	Austin.Linode.Plan[]

Avail_NodeBalancers() public method

Returns NodeBalancer pricing information.

public Avail_NodeBalancers ( ) : void
return	void

Avail_StackScripts() public method

Returns a list of available public StackScripts.

public Avail_StackScripts ( int DistributionID = null, string DistributionVendor = null, string keywords = null ) : void
DistributionID	int	Limit the results to StackScripts that can be applied to this DistributionID
DistributionVendor	string	Debian, Ubuntu, Fedora, etc.
keywords	string	Search terms
return	void

Domain_Create() public method

Create a domain record.

possible errors: NOACCESS,VALIDATION

public Domain_Create ( string Domain, string Type, string axfr_ips = null, string Description = null, int Expire_sec = null, string lpm_displayGroup = null, string master_ips = null, int Refresh_sec = null, int Retry_sec = null, string SOA_Email = null, int status = null, int TTL_sec = null ) : void
Domain	string	The zone's name
Type	string	master or slave
axfr_ips	string	IP addresses allowed to AXFR the entire zone, semicolon separated
Description	string	Currently undisplayed.
Expire_sec	int
lpm_displayGroup	string	Display group in the Domain list inside the Linode DNS Manager
master_ips	string	When type=slave, the zone's master DNS servers list, semicolon separated
Refresh_sec	int
Retry_sec	int
SOA_Email	string	Required when type=master
status	int	0, 1, or 2 (disabled, active, edit mode)
TTL_sec	int
return	void

Domain_Delete() public method

possible errors: NOTFOUND

public Domain_Delete ( int DomainID ) : void
DomainID	int
return	void

Domain_List() public method

Lists domains you have access to.

public Domain_List ( int DomainID = null ) : void
DomainID	int	Limits the list to the specified DomainID
return	void

Domain_Resource_Create() public method

Create a domain record.

possible errors: NOACCESS,VALIDATION

public Domain_Resource_Create ( int DomainID, string Type, string Name = null, int Port = null, int Priority = null, string Protocol = null, string Target = null, int TTL_sec = null, int Weight = null ) : void
DomainID	int
Type	string	One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
Name	string	The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server.
Port	int
Priority	int	Priority for MX and SRV records, 0-255
Protocol	string	The protocol to append to an SRV record. Ignored on other record types.
Target	string	When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.
TTL_sec	int	TTL. Leave as 0 to accept our default.
Weight	int
return	void

Domain_Resource_Delete() public method

possible errors: NOTFOUND

public Domain_Resource_Delete ( int DomainID, int ResourceID ) : void
DomainID	int
ResourceID	int
return	void

Domain_Resource_List() public method

public Domain_Resource_List ( int DomainID, int ResourceID = null ) : void
DomainID	int
ResourceID	int
return	void

Domain_Resource_Update() public method

Update a domain record.

possible errors: NOTFOUND,VALIDATION

public Domain_Resource_Update ( int ResourceID, int DomainID = null, string Name = null, int Port = null, int Priority = null, string Protocol = null, string Target = null, int TTL_sec = null, int Weight = null ) : void
ResourceID	int
DomainID	int
Name	string	The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server.
Port	int
Priority	int	Priority for MX and SRV records, 0-255
Protocol	string	The protocol to append to an SRV record. Ignored on other record types.
Target	string	When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.
TTL_sec	int	TTL. Leave as 0 to accept our default.
Weight	int
return	void

Domain_Update() public method

Update a domain record.

possible errors: NOTFOUND,VALIDATION

public Domain_Update ( int DomainID, string axfr_ips = null, string Description = null, string Domain = null, int Expire_sec = null, string lpm_displayGroup = null, string master_ips = null, int Refresh_sec = null, int Retry_sec = null, string SOA_Email = null, int status = null, int TTL_sec = null, string Type = null ) : void
DomainID	int
axfr_ips	string	IP addresses allowed to AXFR the entire zone, semicolon separated
Description	string	Currently undisplayed.
Domain	string	The zone's name
Expire_sec	int
lpm_displayGroup	string	Display group in the Domain list inside the Linode DNS Manager
master_ips	string	When type=slave, the zone's master DNS servers list, semicolon separated
Refresh_sec	int
Retry_sec	int
SOA_Email	string	Required when type=master
status	int	0, 1, or 2 (disabled, active, edit mode)
TTL_sec	int
Type	string	master or slave
return	void

Image_Delete() public method

Deletes a gold-master image

possible errors: NOTFOUND

public Image_Delete ( int ImageID ) : void
ImageID	int	The ID of the gold-master image to delete
return	void

Image_List() public method

Lists available gold-master images

possible errors: NOTFOUND

public Image_List ( int ImageID = null, int pending = null ) : void
ImageID	int	Request information for a specific gold-master image
pending	int	Show images currently being created.
return	void

Image_Update() public method

Update an Image record.

possible errors: NOTFOUND,VALIDATION

public Image_Update ( int ImageID, string description = null, string label = null ) : void
ImageID	int	The ID of the Image to modify.
description	string	An optional description of the Image.
label	string	The label of the Image.
return	void

Linode_Boot() public method

Issues a boot job for the provided ConfigID. If no ConfigID is provided boots the last used configuration profile, or the first configuration profile if this Linode has never been booted.

possible errors: NOTFOUND

public Linode_Boot ( int LinodeID, int ConfigID = null ) : Austin.Linode.JobIdResponse
LinodeID	int
ConfigID	int	The ConfigID to boot, available from linode.config.list().
return	Austin.Linode.JobIdResponse

Linode_Clone() public method

Creates a new Linode, assigns you full privileges, and then clones the specified LinodeID to the new Linode. There is a limit of 5 active clone operations per source Linode. It is recommended that the source Linode be powered down during the clone.

possible errors: NOACCESS,NOTFOUND,CCFAILED,VALIDATION,LINODELIMITER,ACCOUNTLIMIT

public Linode_Clone ( int DatacenterID, int LinodeID, int PlanID, int PaymentTerm = null ) : Austin.Linode.LinodeIdResponse
DatacenterID	int	The DatacenterID from avail.datacenters() where you wish to place this new Linode
LinodeID	int	The LinodeID that you want cloned
PlanID	int	The desired PlanID available from avail.LinodePlans()
PaymentTerm	int	Subscription term in months for prepaid customers. One of: 1, 12, or 24
return	Austin.Linode.LinodeIdResponse

Linode_Config_Create() public method

Creates a Linode Configuration Profile.

possible errors: NOTFOUND,VALIDATION

public Linode_Config_Create ( string DiskList, int KernelID, string Label, int LinodeID, string Comments = null, bool devtmpfs_automount = null, bool helper_depmod = null, bool helper_disableUpdateDB = null, bool helper_distro = null, bool helper_network = null, bool helper_xen = null, int RAMLimit = null, string RootDeviceCustom = null, int RootDeviceNum = null, bool RootDeviceRO = null, string RunLevel = null, string virt_mode = null ) : Austin.Linode.ConfigIdResponse
DiskList	string	A comma delimited list of DiskIDs; position reflects device node. The 9th element for specifying the initrd.
KernelID	int	The KernelID for this profile. Found in avail.kernels()
Label	string	The Label for this profile
LinodeID	int
Comments	string	Comments you wish to save along with this profile
devtmpfs_automount	bool	Controls if pv_ops kernels should automount devtmpfs at boot.
helper_depmod	bool	Creates an empty modprobe file for the kernel you're booting.
helper_disableUpdateDB	bool	Enable the disableUpdateDB filesystem helper
helper_distro	bool	Enable the Distro filesystem helper. Corrects fstab and inittab/upstart entries depending on the kernel you're booting. You want this.
helper_network	bool	Automatically creates network configuration files for your distro and places them into your filesystem.
helper_xen	bool	Deprecated - use helper_distro.
RAMLimit	int	RAMLimit in MB. 0 for max.
RootDeviceCustom	string	A custom root device setting.
RootDeviceNum	int	Which device number (1-8) that contains the root partition. 0 to utilize RootDeviceCustom.
RootDeviceRO	bool	Enables the 'ro' kernel flag. Modern distros want this.
RunLevel	string	One of 'default', 'single', 'binbash'
virt_mode	string	Controls the virtualization mode. One of 'paravirt', 'fullvirt'
return	Austin.Linode.ConfigIdResponse

Linode_Config_Delete() public method

Deletes a Linode Configuration Profile.

possible errors: NOTFOUND,VALIDATION

public Linode_Config_Delete ( int ConfigID, int LinodeID ) : Austin.Linode.ConfigIdResponse
ConfigID	int
LinodeID	int
return	Austin.Linode.ConfigIdResponse

Linode_Config_List() public method

Lists a Linode's Configuration Profiles.

possible errors: NOTFOUND

public Linode_Config_List ( int LinodeID, int ConfigID = null ) : void
LinodeID	int
ConfigID	int
return	void

Linode_Config_Update() public method

Updates a Linode Configuration Profile.

possible errors: NOTFOUND,VALIDATION

public Linode_Config_Update ( int ConfigID, string Comments = null, bool devtmpfs_automount = null, string DiskList = null, bool helper_depmod = null, bool helper_disableUpdateDB = null, bool helper_distro = null, bool helper_network = null, bool helper_xen = null, int KernelID = null, string Label = null, int LinodeID = null, int RAMLimit = null, string RootDeviceCustom = null, int RootDeviceNum = null, bool RootDeviceRO = null, string RunLevel = null, string virt_mode = null ) : Austin.Linode.ConfigIdResponse
ConfigID	int
Comments	string	Comments you wish to save along with this profile
devtmpfs_automount	bool	Controls if pv_ops kernels should automount devtmpfs at boot.
DiskList	string	A comma delimited list of DiskIDs; position reflects device node. The 9th element for specifying the initrd.
helper_depmod	bool	Creates an empty modprobe file for the kernel you're booting.
helper_disableUpdateDB	bool	Enable the disableUpdateDB filesystem helper
helper_distro	bool	Enable the Distro filesystem helper. Corrects fstab and inittab/upstart entries depending on the kernel you're booting. You want this.
helper_network	bool	Automatically creates network configuration files for your distro and places them into your filesystem.
helper_xen	bool	Deprecated - use helper_distro.
KernelID	int	The KernelID for this profile. Found in avail.kernels()
Label	string	The Label for this profile
LinodeID	int
RAMLimit	int	RAMLimit in MB. 0 for max.
RootDeviceCustom	string	A custom root device setting.
RootDeviceNum	int	Which device number (1-8) that contains the root partition. 0 to utilize RootDeviceCustom.
RootDeviceRO	bool	Enables the 'ro' kernel flag. Modern distros want this.
RunLevel	string	One of 'default', 'single', 'binbash'
virt_mode	string	Controls the virtualization mode. One of 'paravirt', 'fullvirt'
return	Austin.Linode.ConfigIdResponse

Linode_Create() public method

Creates a Linode and assigns you full privileges. There is a 250-linodes-per-hour limiter.

possible errors: NOACCESS,CCFAILED,VALIDATION,LINODELIMITER,ACCOUNTLIMIT

public Linode_Create ( int DatacenterID, int PlanID, int PaymentTerm = null ) : Austin.Linode.LinodeIdResponse
DatacenterID	int	The DatacenterID from avail.datacenters() where you wish to place this new Linode
PlanID	int	The desired PlanID available from avail.LinodePlans()
PaymentTerm	int	Subscription term in months for prepaid customers. One of: 1, 12, or 24
return	Austin.Linode.LinodeIdResponse

Linode_Delete() public method

Immediately removes a Linode from your account and issues a pro-rated credit back to your account, if applicable. To prevent accidental deletes, this requires the Linode has no Disk images. You must first delete its disk images."

possible errors: NOTFOUND,LINODENOTEMPTY

public Linode_Delete ( int LinodeID, bool skipChecks = null ) : Austin.Linode.LinodeIdResponse
LinodeID	int	The LinodeID to delete
skipChecks	bool	Skips the safety checks and will always delete the Linode
return	Austin.Linode.LinodeIdResponse

Linode_Disk_Create() public method

possible errors: NOTFOUND,VALIDATION

public Linode_Disk_Create ( string Label, int LinodeID, int Size, string Type, bool isReadOnly = null ) : Austin.Linode.DiskIdResponse
Label	string	The display label for this Disk
LinodeID	int
Size	int	The size in MB of this Disk.
Type	string	The formatted type of this disk. Valid types are: ext3, ext4, swap, raw
isReadOnly	bool	Enable forced read-only for this Disk
return	Austin.Linode.DiskIdResponse

Linode_Disk_CreateFromDistribution() public method

possible errors: NOTFOUND,VALIDATION

public Linode_Disk_CreateFromDistribution ( int DistributionID, string Label, int LinodeID, string rootPass, int Size, string rootSSHKey = null ) : Austin.Linode.DiskIdResponse
DistributionID	int	The DistributionID to create this disk from. Found in avail.distributions()
Label	string	The label of this new disk image
LinodeID	int
rootPass	string	The root user's password
Size	int	Size of this disk image in MB
rootSSHKey	string	Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.
return	Austin.Linode.DiskIdResponse

Linode_Disk_CreateFromImage() public method

Creates a new disk from a previously imagized disk.

public Linode_Disk_CreateFromImage ( int ImageID, int LinodeID, string Label = null, string rootPass = null, string rootSSHKey = null, int size = null ) : void
ImageID	int	The ID of the frozen image to deploy from
LinodeID	int	Specifies the Linode to deploy on to
Label	string	The label of this new disk image
rootPass	string	Optionally sets the root password at deployment time. If a password is not provided the existing root password of the frozen image will not be modified
rootSSHKey	string	Optionally sets this string into /root/.ssh/authorized_keys upon image deployment
size	int	The size of the disk image to creates. Defaults to the minimum size required for the requested image
return	void

Linode_Disk_CreateFromStackScript() public method

possible errors: NOTFOUND,VALIDATION

public Linode_Disk_CreateFromStackScript ( int DistributionID, string Label, int LinodeID, string rootPass, int Size, int StackScriptID, string StackScriptUDFResponses, string rootSSHKey = null ) : Austin.Linode.DiskIdResponse
DistributionID	int	Which Distribution to apply this StackScript to. Must be one from the script's DistributionIDList
Label	string	The label of this new disk image
LinodeID	int
rootPass	string	The root user's password
Size	int	Size of this disk image in MB
StackScriptID	int	The StackScript to create this image from
StackScriptUDFResponses	string	JSON encoded name/value pairs, answering this StackScript's User Defined Fields
rootSSHKey	string	Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.
return	Austin.Linode.DiskIdResponse

Linode_Disk_Delete() public method

possible errors: NOTFOUND,VALIDATION

public Linode_Disk_Delete ( int DiskID, int LinodeID ) : Austin.Linode.DiskIdResponse
DiskID	int
LinodeID	int
return	Austin.Linode.DiskIdResponse

Linode_Disk_Duplicate() public method

Performs a bit-for-bit copy of a disk image.

possible errors: NOTFOUND,VALIDATION

public Linode_Disk_Duplicate ( int DiskID, int LinodeID ) : Austin.Linode.DiskIdResponse
DiskID	int
LinodeID	int
return	Austin.Linode.DiskIdResponse

Linode_Disk_Imagize() public method

Creates a gold-master image for future deployments

public Linode_Disk_Imagize ( int DiskID, int LinodeID, string Description = null, string Label = null ) : void
DiskID	int	Specifies the source Disk to create the image from
LinodeID	int	Specifies the source Linode to create the image from
Description	string	An optional description of the created image
Label	string	Sets the name of the image shown in the base image list, defaults to the source image label
return	void

Linode_Disk_List() public method

Status values are 1: Ready and 2: Being Deleted.

public Linode_Disk_List ( int LinodeID, int DiskID = null ) : void
LinodeID	int
DiskID	int
return	void

Linode_Disk_Resize() public method

possible errors: NOTFOUND,VALIDATION

public Linode_Disk_Resize ( int DiskID, int LinodeID, int size ) : Austin.Linode.DiskIdResponse
DiskID	int
LinodeID	int
size	int	The requested new size of this Disk in MB
return	Austin.Linode.DiskIdResponse

Linode_Disk_Update() public method

possible errors: NOTFOUND,VALIDATION

public Linode_Disk_Update ( int DiskID, bool isReadOnly = null, string Label = null, int LinodeID = null ) : void
DiskID	int
isReadOnly	bool	Enable forced read-only for this Disk
Label	string	The display label for this Disk
LinodeID	int
return	void

Linode_Ip_AddPrivate() public method

Assigns a Private IP to a Linode. Returns the IPAddressID that was added.

possible errors: NOTFOUND

public Linode_Ip_AddPrivate ( int LinodeID ) : Austin.Linode.IpAddressResponse
LinodeID	int
return	Austin.Linode.IpAddressResponse

Linode_Ip_AddPublic() public method

Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress that was added.

possible errors: NOTFOUND,VALIDATION

public Linode_Ip_AddPublic ( int LinodeID ) : Austin.Linode.IpAddressResponse
LinodeID	int	The LinodeID of the Linode that will be assigned an additional public IP address
return	Austin.Linode.IpAddressResponse

Linode_Ip_List() public method

Returns the IP addresses of all Linodes you have access to.

possible errors: NOTFOUND

public Linode_Ip_List ( int IPAddressID = null, int LinodeID = null ) : Austin.Linode.IpAddressListEntry[]
IPAddressID	int	If specified, limits the result to this IPAddressID
LinodeID	int	If specified, limits the result to this LinodeID
return	Austin.Linode.IpAddressListEntry[]

Linode_Ip_SetRDns() public method

Sets the rDNS name of a Public IP. Returns the IPAddressID and IPAddress that were updated.

possible errors: NOTFOUND,VALIDATION

public Linode_Ip_SetRDns ( string Hostname, int IPAddressID ) : void
Hostname	string	The hostname to set the reverse DNS to
IPAddressID	int	The IPAddressID of the address to update
return	void

Linode_Ip_Swap() public method

Exchanges Public IP addresses between two Linodes within a Datacenter. The destination of the IP Address can be designated by either the toLinodeID or withIPAddressID parameter. Returns the resulting relationship of the Linode and IP Address parameters. When performing a one directional swap, the source is represented by the first of the two resultant array members.

possible errors: NOTFOUND,VALIDATION

public Linode_Ip_Swap ( int IPAddressID, int toLinodeID = null, int withIPAddressID = null ) : void
IPAddressID	int	The IPAddressID of an IP Address to transfer or swap
toLinodeID	int	The LinodeID of the Linode where IPAddressID will be transfered
withIPAddressID	int	The IP Address ID to swap
return	void

Linode_Job_List() public method

public Linode_Job_List ( int LinodeID, int JobID = null, bool pendingOnly = null ) : Austin.Linode.Job[]
LinodeID	int
JobID	int	Limits the list to the specified JobID
pendingOnly	bool
return	Austin.Linode.Job[]

Linode_Kvmify() public method

Changes a Linode's hypervisor from Xen to KVM.

possible errors: NOTFOUND,VALIDATION

public Linode_Kvmify ( int LinodeID ) : void
LinodeID	int	The LinodeID to migrate to KVM.
return	void

Linode_List() public method

Returns a list of all Linodes user has access or delete to, including some properties. Status values are -1: Being Created, 0: Brand New, 1: Running, and 2: Powered Off.

public Linode_List ( int LinodeID = null ) : Austin.Linode.Node[]
LinodeID	int	Limits the list to the specified LinodeID
return	Austin.Linode.Node[]

Linode_Mutate() public method

Upgrades a Linode to its next generation.

possible errors: NOTFOUND,VALIDATION

public Linode_Mutate ( int LinodeID ) : void
LinodeID	int
return	void

Linode_Reboot() public method

Issues a shutdown, and then boot job for a given LinodeID.

possible errors: NOTFOUND

public Linode_Reboot ( int LinodeID, int ConfigID = null ) : Austin.Linode.JobIdResponse
LinodeID	int
ConfigID	int
return	Austin.Linode.JobIdResponse

Linode_Resize() public method

Resizes a Linode from one plan to another. Immediately shuts the Linode down, charges/credits the account, and issue a migration to another host server.

possible errors: NOTFOUND,CCFAILED,VALIDATION

public Linode_Resize ( int LinodeID, int PlanID ) : void
LinodeID	int
PlanID	int	The desired PlanID available from avail.LinodePlans()
return	void

Linode_Shutdown() public method

Issues a shutdown job for a given LinodeID.

possible errors: NOTFOUND

public Linode_Shutdown ( int LinodeID ) : Austin.Linode.JobIdResponse
LinodeID	int
return	Austin.Linode.JobIdResponse

Linode_Update() public method

Updates a Linode's properties.

possible errors: NOTFOUND,VALIDATION

public Linode_Update ( int LinodeID, bool Alert_bwin_enabled = null, int Alert_bwin_threshold = null, bool Alert_bwout_enabled = null, int Alert_bwout_threshold = null, bool Alert_bwquota_enabled = null, int Alert_bwquota_threshold = null, bool Alert_cpu_enabled = null, int Alert_cpu_threshold = null, bool Alert_diskio_enabled = null, int Alert_diskio_threshold = null, int backupWeeklyDay = null, int backupWindow = null, string Label = null, string lpm_displayGroup = null, bool ms_ssh_disabled = null, string ms_ssh_ip = null, int ms_ssh_port = null, string ms_ssh_user = null, bool watchdog = null ) : Austin.Linode.LinodeIdResponse
LinodeID	int
Alert_bwin_enabled	bool	Enable the incoming bandwidth email alert
Alert_bwin_threshold	int	Mb/sec
Alert_bwout_enabled	bool	Enable the outgoing bandwidth email alert
Alert_bwout_threshold	int	Mb/sec
Alert_bwquota_enabled	bool	Enable the bw quote email alert
Alert_bwquota_threshold	int	Percentage of monthly bw quota
Alert_cpu_enabled	bool	Enable the cpu usage email alert
Alert_cpu_threshold	int	CPU Alert threshold, percentage 0-800
Alert_diskio_enabled	bool	Enable the disk IO email alert
Alert_diskio_threshold	int	IO ops/sec
backupWeeklyDay	int
backupWindow	int
Label	string	This Linode's label
lpm_displayGroup	string	Display group in the Linode list inside the Linode Manager
ms_ssh_disabled	bool
ms_ssh_ip	string
ms_ssh_port	int
ms_ssh_user	string
watchdog	bool	Enable the Lassie shutdown watchdog
return	Austin.Linode.LinodeIdResponse

Linode_WebConsoleToken() public method

Generates a console token starting a web console LISH session for the requesting IP

possible errors: NOTFOUND,VALIDATION

public Linode_WebConsoleToken ( int LinodeID ) : void
LinodeID	int
return	void

NodeBalancer_Config_Create() public method

possible errors: NOTFOUND,VALIDATION

public NodeBalancer_Config_Create ( int NodeBalancerID, string Algorithm = null, string check = null, string check_attempts = null, string check_body = null, int check_interval = null, bool check_passive = null, string check_path = null, string check_timeout = null, string cipher_suite = null, int Port = null, string Protocol = null, string ssl_cert = null, string ssl_key = null, string Stickiness = null ) : void
NodeBalancerID	int	The parent NodeBalancer's ID
Algorithm	string	Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
check	string	Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'
check_attempts	string	Number of failed probes before taking a node out of rotation. 1-30
check_body	string	When check=http, a regex to match within the first 16,384 bytes of the response body
check_interval	int	Seconds between health check probes. 2-3600
check_passive	bool	Enable passive checks based on observing communication with back-end nodes.
check_path	string	When check=http, the path to request
check_timeout	string	Seconds to wait before considering the probe a failure. 1-30. Must be less than check_interval.
cipher_suite	string	SSL cipher suite to enforce. One of 'recommended', 'legacy'
Port	int	Port to bind to on the public interfaces. 1-65534
Protocol	string	Either 'tcp', 'http', or 'https'
ssl_cert	string	SSL certificate served by the NodeBalancer when the protocol is 'https'
ssl_key	string	Unpassphrased private key for the SSL certificate when protocol is 'https'
Stickiness	string	Session persistence. One of 'none', 'table', 'http_cookie'
return	void

NodeBalancer_Config_Delete() public method

Deletes a NodeBalancer's Config

possible errors: NOTFOUND

public NodeBalancer_Config_Delete ( int ConfigID, int NodeBalancerID ) : void
ConfigID	int	The ConfigID to delete
NodeBalancerID	int
return	void

NodeBalancer_Config_List() public method

Returns a list of NodeBalancers this user has access or delete to, including their properties

public NodeBalancer_Config_List ( int NodeBalancerID, int ConfigID = null ) : void
NodeBalancerID	int
ConfigID	int	Limits the list to the specified ConfigID
return	void

NodeBalancer_Config_Update() public method

Updates a Config's properties

possible errors: NOTFOUND,VALIDATION

public NodeBalancer_Config_Update ( int ConfigID, string Algorithm = null, string check = null, string check_attempts = null, string check_body = null, int check_interval = null, bool check_passive = null, string check_path = null, string check_timeout = null, string cipher_suite = null, int Port = null, string Protocol = null, string ssl_cert = null, string ssl_key = null, string Stickiness = null ) : void
ConfigID	int
Algorithm	string	Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
check	string	Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'
check_attempts	string	Number of failed probes before taking a node out of rotation. 1-30
check_body	string	When check=http, a regex to match within the first 16,384 bytes of the response body
check_interval	int	Seconds between health check probes. 2-3600
check_passive	bool	Enable passive checks based on observing communication with back-end nodes.
check_path	string	When check=http, the path to request
check_timeout	string	Seconds to wait before considering the probe a failure. 1-30. Must be less than check_interval.
cipher_suite	string	SSL cipher suite to enforce. One of 'recommended', 'legacy'
Port	int	Port to bind to on the public interfaces. 1-65534
Protocol	string	Either 'tcp', 'http', or 'https'
ssl_cert	string	SSL certificate served by the NodeBalancer when the protocol is 'https'
ssl_key	string	Unpassphrased private key for the SSL certificate when protocol is 'https'
Stickiness	string	Session persistence. One of 'none', 'table', 'http_cookie'
return	void

NodeBalancer_Create() public method

possible errors: NOACCESS,CCFAILED,VALIDATION

public NodeBalancer_Create ( int DatacenterID, int ClientConnThrottle = null, string Label = null ) : void
DatacenterID	int	The DatacenterID from avail.datacenters() where you wish to place this new NodeBalancer
ClientConnThrottle	int	To help mitigate abuse, throttle connections per second, per client IP. 0 to disable. Max of 20.
Label	string	This NodeBalancer's label
return	void

NodeBalancer_Delete() public method

Immediately removes a NodeBalancer from your account and issues a pro-rated credit back to your account, if applicable.

possible errors: NOTFOUND

public NodeBalancer_Delete ( int NodeBalancerID ) : void
NodeBalancerID	int	The NodeBalancerID to delete
return	void

NodeBalancer_List() public method

Returns a list of NodeBalancers this user has access or delete to, including their properties

public NodeBalancer_List ( int NodeBalancerID = null ) : void
NodeBalancerID	int	Limits the list to the specified NodeBalancerID
return	void

NodeBalancer_Node_Create() public method

possible errors: NOTFOUND,VALIDATION

public NodeBalancer_Node_Create ( string Address, int ConfigID, string Label, string Mode = null, int Weight = null ) : void
Address	string	The address:port combination used to communicate with this Node
ConfigID	int	The parent ConfigID to attach this Node to
Label	string	This backend Node's label
Mode	string	The connections mode for this node. One of 'accept', 'reject', or 'drain'
Weight	int	Load balancing weight, 1-255. Higher means more connections.
return	void

NodeBalancer_Node_Delete() public method

Deletes a Node from a NodeBalancer Config

possible errors: NOTFOUND

public NodeBalancer_Node_Delete ( int NodeID ) : void
NodeID	int	The NodeID to delete
return	void

NodeBalancer_Node_List() public method

Returns a list of Nodes associated with a NodeBalancer Config

public NodeBalancer_Node_List ( int ConfigID, int NodeID = null ) : void
ConfigID	int
NodeID	int	Limits the list to the specified NodeID
return	void

NodeBalancer_Node_Update() public method

Updates a Node's properties

possible errors: NOTFOUND,VALIDATION

public NodeBalancer_Node_Update ( int NodeID, string Address = null, string Label = null, string Mode = null, int Weight = null ) : void
NodeID	int
Address	string	The address:port combination used to communicate with this Node
Label	string	This backend Node's label
Mode	string	The connections mode for this node. One of 'accept', 'reject', or 'drain'
Weight	int	Load balancing weight, 1-255. Higher means more connections.
return	void

NodeBalancer_Update() public method

Updates a NodeBalancer's properties

possible errors: NOTFOUND,VALIDATION

public NodeBalancer_Update ( int NodeBalancerID, int ClientConnThrottle = null, string Label = null ) : void
NodeBalancerID	int
ClientConnThrottle	int	To help mitigate abuse, throttle connections per second, per client IP. 0 to disable. Max of 20.
Label	string	This NodeBalancer's label
return	void

StackScript_Create() public method

Create a StackScript.

possible errors: NOACCESS,VALIDATION

public StackScript_Create ( string DistributionIDList, string Label, string script, string Description = null, bool isPublic = null, string rev_note = null ) : void
DistributionIDList	string	Comma delimited list of DistributionIDs that this script works on
Label	string	The Label for this StackScript
script	string	The actual script
Description	string
isPublic	bool	Whether this StackScript is published in the Library, for everyone to use
rev_note	string
return	void

StackScript_Delete() public method

possible errors: NOTFOUND

public StackScript_Delete ( int StackScriptID ) : void
StackScriptID	int
return	void

StackScript_List() public method

Lists StackScripts you have access to.

public StackScript_List ( int StackScriptID = null ) : void
StackScriptID	int	Limits the list to the specified StackScriptID
return	void

StackScript_Update() public method

Update a StackScript.

possible errors: NOTFOUND,VALIDATION

public StackScript_Update ( int StackScriptID, string Description = null, string DistributionIDList = null, bool isPublic = null, string Label = null, string rev_note = null, string script = null ) : void
StackScriptID	int
Description	string
DistributionIDList	string	Comma delimited list of DistributionIDs that this script works on
isPublic	bool	Whether this StackScript is published in the Library, for everyone to use
Label	string	The Label for this StackScript
rev_note	string
script	string	The actual script
return	void

Test_Echo() public method

Echos back parameters that were passed in.

public Test_Echo ( ) : void
return	void

User_GetApiKey() public method

Authenticates a Linode Manager user against their username, password, and two-factor token (when enabled), and then returns a new API key, which can be used until it expires. The number of active keys is limited to 20. Batch requests will be rejected if they include this API action.

possible errors: AUTHFAIL,NEEDTOKEN,PASSWORDEXPIRED,KEYLIMIT

public User_GetApiKey ( string password, string username, int expires = null, string label = null, string token = null ) : void
password	string
username	string
expires	int	Number of hours the key will remain valid, between 0 and 8760. 0 means no expiration. Defaults to 168.
label	string	An optional label for this key.
token	string	Required when two-factor authentication is enabled.
return	void

Property Details

GeneratedApiVersion public_oe property

From what version of the API spec was this code generated from.

public Version,System GeneratedApiVersion
return	System.Version