Fix more broken / invalid docstrings in the 1&1 driver.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/1b8d594c Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/1b8d594c Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/1b8d594c Branch: refs/heads/trunk Commit: 1b8d594cfc5ab80a98d61fbcd1c703295b0c66d6 Parents: 1927c80 Author: Tomaz Muraus <[email protected]> Authored: Wed Sep 6 17:36:58 2017 +0200 Committer: Tomaz Muraus <[email protected]> Committed: Sun Sep 10 21:51:29 2017 +0200 ---------------------------------------------------------------------- libcloud/compute/drivers/oneandone.py | 267 +++++++++++++++-------------- 1 file changed, 136 insertions(+), 131 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/1b8d594c/libcloud/compute/drivers/oneandone.py ---------------------------------------------------------------------- diff --git a/libcloud/compute/drivers/oneandone.py b/libcloud/compute/drivers/oneandone.py index 5f2bcbb..79d7d33 100644 --- a/libcloud/compute/drivers/oneandone.py +++ b/libcloud/compute/drivers/oneandone.py @@ -199,48 +199,41 @@ class OneAndOneNodeDriver(NodeDriver): Creates a node. :param name: The name of the new node - :type `str` - - :param image: Image from list_images - :rtype: image: + :type name: `str` :param ex_fixed_instance_size_id: Fixed instance size ID from list_sizes - :rtype: ``str`` + :type ex_fixed_instance_size_id: ``str`` :param location: 1&1 Data center Location - :type `NodeLocation` - - :param auth: SSH key or root password - :type: :class:`NodeAuthSSHKey` or :class:`NodeAuthPassword` + :type location: `NodeLocation` :param ex_ip: IP address - :type `str` + :type ex_ip: `str` :param ex_ssh_key: SSH Key - :type `str` + :type ex_ssh_key: `str` :param password: Password - :type `str` + :type password: `str` :param ex_monitoring_policy_id: - :type `str` + :type ex_firewall_policy_id: `str` :param ex_firewall_policy_id: - :type `str` + :type ex_firewall_policy_id: `str` :param ex_loadbalancer_id: - :type `str` + :type ex_loadbalancer_id: `str` :param ex_description: - :type `str` + :type ex_description: `str` :param ex_power_on: - :type `bool` - + :type ex_power_on: `bool` :return: Instance of class ``Node`` - :rtype: :class: `Node` + :rtype: :class:`Node` """ body = { @@ -352,11 +345,12 @@ class OneAndOneNodeDriver(NodeDriver): """ Renames the server :param server_id: ID of the server you want to rename + :param name: New name of the server - :rtype: ``str`` + :type: ``str`` :param description: New description of the server - :rtype: ``str`` + :type: ``str`` :return: Instance of class ``Node`` :rtype: :class: `Node` @@ -381,7 +375,7 @@ class OneAndOneNodeDriver(NodeDriver): Gets all server hardware :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :return: Server's hardware :rtype: ``dict`` @@ -403,22 +397,22 @@ class OneAndOneNodeDriver(NodeDriver): Modifies server's hardware :param server_id: - :rtype: ``str`` + :type: ``str`` :param fixed_instance_size_id: Id of the fixed instance size - :rtype: ``str`` + :type: ``str`` :param vcore: Virtual cores count - :rtype: ``int`` + :type: ``int`` :param cores_per_processor: Count of cores per procesor - :rtype: ``int`` + :type: ``int`` :param ram: Amount of ram for the server - :rtype: ``int`` + :type: ``int`` :return: Instance of class ``Node`` - :rtype: :class: `Node` + :type: :class: `Node` """ body = {} @@ -449,14 +443,13 @@ class OneAndOneNodeDriver(NodeDriver): Modifies server hard disk drives :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param hdd_id: Id of the hard disk - :rtype: ``str`` + :type: ``str`` :param size: Size of the hard disk - :rtype: ``str`` - + :type: ``str`` :return: Instance of class ``Node`` :rtype: :class: `Node` @@ -480,16 +473,16 @@ class OneAndOneNodeDriver(NodeDriver): Add a hard disk to the server :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param size: Size of the new disk - :rtype: ``str`` + :type: ``str`` :param is_main: Indicates if the disk is going to be the boot disk - :rtype: ``boolean`` + :type: ``boolean`` :return: Instance of class ``Node`` - :rtype: :class: `Node` + :type: :class: `Node` """ body = { 'size': size, @@ -509,10 +502,10 @@ class OneAndOneNodeDriver(NodeDriver): Removes existing hard disk :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param hdd_id: Id of the hard disk - :rtype: ``str`` + :type: ``str`` :return: Instance of class ``Node`` :rtype: :class: `Node` @@ -548,7 +541,8 @@ class OneAndOneNodeDriver(NodeDriver): Gets a server :param server_id: Id of the server to be retrieved - :rtype: ``str`` + :type: ``str`` + :return: Instance of class ``Node`` :rtype: :class: `Node` """ @@ -565,7 +559,7 @@ class OneAndOneNodeDriver(NodeDriver): Shuts down the server :param server_id: Id of the server to be shut down - :rtype: ``str`` + :type: ``str`` :param method: Method of shutting down "SOFTWARE" or "HARDWARE" @@ -593,7 +587,7 @@ class OneAndOneNodeDriver(NodeDriver): Gets server image :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :return: Server image :rtype: ``dict`` @@ -610,10 +604,10 @@ class OneAndOneNodeDriver(NodeDriver): Installs a new image on the server :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param image_id: Id of the image (Server Appliance) - :rtype: ``str`` + :type: ``str`` :param password: New password for the server @@ -644,7 +638,7 @@ class OneAndOneNodeDriver(NodeDriver): Gets all server IP objects :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :return: List of server IP objects :rtype: ``list`` of ``dict`` @@ -661,10 +655,10 @@ class OneAndOneNodeDriver(NodeDriver): Get a single server IP object :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param ip_id: ID of the IP address - :rtype: ``str`` + :type: ``str`` :return: IP address object :rtype: ``dict`` @@ -681,10 +675,10 @@ class OneAndOneNodeDriver(NodeDriver): Assigns a new IP address to the server :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param ip_type: Type of the IP address [IPV4,IPV6] - :rtype: ``str`` + :type: ``str`` :return: ``Node`` instance :rtype: ``Node`` @@ -707,14 +701,14 @@ class OneAndOneNodeDriver(NodeDriver): Removes an IP address from the server :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param ip_id: ID of the IP address - :rtype: ``str`` + :type: ``str`` :param keep_ip: Indicates whether IP address will be removed from - the Cloud Panel - :rtype: ``boolean`` + the Cloud Panel + :type: ``boolean`` :return: ``Node`` instance :rtype: ``Node`` @@ -735,11 +729,12 @@ class OneAndOneNodeDriver(NodeDriver): def ex_get_server_firewall_policies(self, server_id, ip_id): """ Gets a firewall policy of attached to the server's IP + :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param ip_id: ID of the IP address - :rtype: ``str`` + :type: ``str`` :return: IP address object :rtype: ``dict`` @@ -757,10 +752,10 @@ class OneAndOneNodeDriver(NodeDriver): Removes a firewall policy from server's IP :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param ip_id: ID of the IP address - :rtype: ``str`` + :type: ``str`` :return: ``Node`` instance :rtype: ``Node`` @@ -777,13 +772,13 @@ class OneAndOneNodeDriver(NodeDriver): Adds a firewall policy to the server's IP address :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :param ip_id: ID of the IP address - :rtype: ``str`` + :type: ``str`` :param firewall_id: ID of the firewall policy - :rtype: ``str`` + :type: ``str`` :return: ``Node`` instance :rtype: ``Node`` @@ -810,6 +805,7 @@ class OneAndOneNodeDriver(NodeDriver): :param name: :param description: :param rules: + :rtype: `dict` :return: `dict` firewall policy @@ -839,6 +835,7 @@ class OneAndOneNodeDriver(NodeDriver): def ex_list_firewall_policies(self): """" List firewall policies + :return: 'dict' """ @@ -852,6 +849,7 @@ class OneAndOneNodeDriver(NodeDriver): def ex_get_firewall_policy(self, fw_id): """ Gets firewall policy + :param fw_id: ID of the firewall policy :return: 'dict' """ @@ -866,6 +864,7 @@ class OneAndOneNodeDriver(NodeDriver): def ex_delete_firewall_policy(self, fw_id): """ Deletes firewall policy + :param fw_id: ID of the Firewall :return: 'dict' """ @@ -937,7 +936,7 @@ class OneAndOneNodeDriver(NodeDriver): Removes a shared storage :param storage_id: Id of the shared storage - :rtype: ``str`` + :type: ``str`` :return: Instnace of shared storage :rtype: ``list`` of ``dict`` @@ -996,10 +995,10 @@ class OneAndOneNodeDriver(NodeDriver): Detaches a server from shared storage :param storage_id: Id of the shared storage - :rtype: ``str`` + :type: ``str`` :param server_id: Id of the server - :rtype: ``str`` + :type: ``str`` :return: Instance of shared storage :rtype: ``dict`` @@ -1128,10 +1127,10 @@ class OneAndOneNodeDriver(NodeDriver): Adds server's IP address to load balancer :param lb_id: Load balancer ID - :rtype: ``str`` + :type: ``str`` :param server_ips: Array of server IP IDs - :rtype: ``list`` of ``str`` + :type: ``list`` of ``str`` :return: Instance of load balancer :rtype: ``dict`` @@ -1153,10 +1152,10 @@ class OneAndOneNodeDriver(NodeDriver): Removes server's IP from load balancer :param lb_id: Load balancer ID - :rtype: ``str`` + :type: ``str`` :param server_ip: ID of the server IP - :rtype: ``str`` + :type: ``str`` :return: Instance of load balancer :rtype: ``dict`` @@ -1252,7 +1251,7 @@ class OneAndOneNodeDriver(NodeDriver): Gets a single load balancer :param lb_id: ID of the load balancer - :rtype: ``str`` + :type lb_id: ``str`` :return: Instance of load balancer :rtype: ``dict`` @@ -1269,7 +1268,7 @@ class OneAndOneNodeDriver(NodeDriver): List balanced server IP addresses :param lb_id: ID of the load balancer - :rtype: ``str`` + :type lb_id: ``str`` :return: Array of IP address IDs :rtype: ``dict`` @@ -1286,10 +1285,10 @@ class OneAndOneNodeDriver(NodeDriver): Gets load balanced server id :param lb_id: ID of the load balancer - :rtype: ``str`` + :type lb_id: ``str`` :param server_ip: ID of the server IP - :rtype: ``str`` + :type server_ip: ``str`` :return: Server IP :rtype: ``dict`` @@ -1306,7 +1305,7 @@ class OneAndOneNodeDriver(NodeDriver): Lists loadbalancer rules :param lb_id: ID of the load balancer - :rtype: ``str`` + :type lb_id: ``str`` :return: Lists of rules :rtype: ``list`` of ``dict`` @@ -1323,10 +1322,10 @@ class OneAndOneNodeDriver(NodeDriver): Get a load balancer rule :param lb_id: ID of the load balancer - :rtype: ``str`` + :type lb_id: ``str`` :param rule_id: Rule ID - :rtype: ``str`` + :type rule_id: ``str`` :return: A load balancer rule :rtype: ``dict`` @@ -1343,10 +1342,10 @@ class OneAndOneNodeDriver(NodeDriver): Deletes a load balancer rule :param lb_id: ID of the load balancer - :rtype: ``str`` + :type lb_id: ``str`` :param rule_id: Rule ID - :rtype: ``str`` + :type rule_id: ``str`` :return: Instance of load balancer :rtype: ``dict`` @@ -1380,14 +1379,14 @@ class OneAndOneNodeDriver(NodeDriver): """ Creates a public IP - :param type: Type of IP IPV4 or IPV6] - :rtype: ``str`` + :param type: Type of IP (IPV4 or IPV6) + :type type: ``str`` :param reverse_dns: Reverse DNS - :rtype: ``str`` + :type reverse_dns: ``str`` :param datacenter_id: Datacenter ID where IP address will be crated - :rtype: ``str`` + :type datacenter_id: ``str`` :return: Instance of Public IP :rtype: ``dict`` @@ -1414,7 +1413,7 @@ class OneAndOneNodeDriver(NodeDriver): Gets a Public IP :param ip_id: ID of the IP - :rtype: ``str`` + :type ip_id: ``str`` :return: Instance of Public IP :rtype: ``dict`` @@ -1431,7 +1430,7 @@ class OneAndOneNodeDriver(NodeDriver): Deletes a public IP :param ip_id: ID of public IP - :rtype: ``str`` + :type ip_id: ``str`` :return: Instance of IP Address :rtype: ``dict`` @@ -1448,10 +1447,10 @@ class OneAndOneNodeDriver(NodeDriver): Updates a Public IP :param ip_id: ID of public IP - :rtype: ``str`` + :type ip_id: ``str`` :param reverse_dns: Reverse DNS - :rtype: ``str`` + :type reverse_dns: ``str`` :return: Instance of Public IP :rtype: ``dict`` @@ -1494,19 +1493,19 @@ class OneAndOneNodeDriver(NodeDriver): Creates a private network :param name: Name of the private network - :rtype: ``str`` + :type name: ``str`` :param description: Description of the private network - :rtype: ``str`` + :type description: ``str`` :param datacenter_id: ID of the data center for the private network - :rtype: ``str`` + :type datacenter_id: ``str`` :param network_address: Network address of the private network - :rtype: ``str`` + :type network_address: ``str`` :param subnet_mask: Subnet mask of the private network - :rtype: ``str`` + :type subnet_mask: ``str`` :return: Newly created private network :rtype: ``dict`` @@ -1537,7 +1536,7 @@ class OneAndOneNodeDriver(NodeDriver): Deletes a private network :param network_id: Id of the private network - :rtype: ``str`` + :type network_id: ``str`` :return: Instance of the private network being deleted :rtype: ``dict`` @@ -1555,26 +1554,26 @@ class OneAndOneNodeDriver(NodeDriver): network_address=None, subnet_mask=None): """ - Updates a private network + Updates a private network - :param name: Name of the private network - :rtype: ``str`` + :param name: Name of the private network + :type name: ``str`` - :param description: Description of the private network - :rtype: ``str`` + :param description: Description of the private network + :type description: ``str`` - :param datacenter_id: ID of the data center for the private network - :rtype: ``str`` + :param datacenter_id: ID of the data center for the private network + :type datacenter_id: ``str`` - :param network_address: Network address of the private network - :rtype: ``str`` + :param network_address: Network address of the private network + :type network_address: ``str`` - :param subnet_mask: Subnet mask of the private network - :rtype: ``str`` + :param subnet_mask: Subnet mask of the private network + :type subnet_mask: ``str`` - :return: Instance of private network - :rtype: ``dict`` - """ + :return: Instance of private network + :rtype: ``dict`` + """ body = {} if name is not None: @@ -1601,7 +1600,7 @@ class OneAndOneNodeDriver(NodeDriver): Lists all private network servers :param network_id: Private network ID - :rtype: ``str`` + :type network_id: ``str`` :return: List of private network servers :rtype: ``dict`` @@ -1617,10 +1616,10 @@ class OneAndOneNodeDriver(NodeDriver): Add servers to private network :param network_id: Private Network ID - :rtype: ``str`` + :type network_id: ``str`` :param server_ids: List of server IDs - :rtype: ``list`` of ``str`` + :type server_ids: ``list`` of ``str`` :return: List of attached servers :rtype: ``dict`` @@ -1644,10 +1643,10 @@ class OneAndOneNodeDriver(NodeDriver): Removes a server from the private network :param network_id: Private Network ID - :rtype: ``str`` + :type network_id: ``str`` :param server_id: Id of the server - :rtype: ``str`` + :type server_id: ``str`` :return: Instance of the private network :rtype: ``dict`` @@ -1737,7 +1736,7 @@ class OneAndOneNodeDriver(NodeDriver): Deletes a monitoring policy :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :return: Instance of the monitoring policy being deleted :rtype: ``dict`` @@ -1757,17 +1756,19 @@ class OneAndOneNodeDriver(NodeDriver): Updates monitoring policy :param policy_id: Id of the monitoring policy + :type policy_id: ``str`` + :param email: Email to send notifications to - :rtype: ``str`` + :type email: ``str`` :param thresholds: Thresholds for the monitoring policy - :rtype: ``dict`` + :type thresholds: ``dict`` :param name: Name of the monitoring policy - :rtype: ``str`` + :type name: ``str`` :param description: Description of the monitoring policy - :rtype: ``str`` + :type description: ``str`` :return: Instance of the monitoring policy being deleted :rtype: ``dict`` @@ -1797,7 +1798,7 @@ class OneAndOneNodeDriver(NodeDriver): Fetches a monitoring policy :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :return: Instance of a monitoring policy :rtype: ``dict`` @@ -1814,6 +1815,7 @@ class OneAndOneNodeDriver(NodeDriver): Fetches monitoring policy ports :param policy_id: Id of the monitoring policy + :type policy_id: :return: Instance of a monitoring policy :rtype: ``dict`` @@ -1831,10 +1833,10 @@ class OneAndOneNodeDriver(NodeDriver): Fetches monitoring policy port :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param port_id: Id of the port - :rtype: ``str`` + :type port_id: ``str`` :return: Instance of a monitoring policy :rtype: ``dict`` @@ -1852,10 +1854,10 @@ class OneAndOneNodeDriver(NodeDriver): Removes monitoring policy port :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param port_id: Id of the port - :rtype: ``str`` + :type port_id: ``str`` :return: Instance of a monitoring policy :rtype: ``dict`` @@ -1873,10 +1875,10 @@ class OneAndOneNodeDriver(NodeDriver): Add monitoring policy ports :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param ports: List of ports - :rtype: ``dict`` + :type ports: ``dict`` [ { 'protocol':'TCP', @@ -1885,6 +1887,7 @@ class OneAndOneNodeDriver(NodeDriver): 'email_notification':true } ] + :return: Instance of a monitoring policy :rtype: ``dict`` """ @@ -1904,6 +1907,7 @@ class OneAndOneNodeDriver(NodeDriver): Fetches monitoring policy processes :param policy_id: Id of the monitoring policy + :type policy_id: ``str`` :return: Instance of a monitoring policy :rtype: ``dict`` @@ -1921,10 +1925,10 @@ class OneAndOneNodeDriver(NodeDriver): Fetches monitoring policy process :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param process_id: Id of the process - :rtype: ``str`` + :type process_id: ``str`` :return: Instance of a monitoring policy :rtype: ``dict`` @@ -1943,10 +1947,10 @@ class OneAndOneNodeDriver(NodeDriver): Removes monitoring policy process :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param process_id: Id of the process - :rtype: ``str`` + :type process_id: ``str`` :return: Instance of a monitoring policy :rtype: ``dict`` @@ -1965,10 +1969,10 @@ class OneAndOneNodeDriver(NodeDriver): Add monitoring policy processes :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param processes: List of processes - :rtype: ``list`` of ``dict`` + :type processes: ``list`` of ``dict`` [ { 'process': 'taskmmgr', @@ -1976,6 +1980,7 @@ class OneAndOneNodeDriver(NodeDriver): 'email_notification': true } ] + :return: Instance of a monitoring policy :rtype: ``dict`` """ @@ -1995,7 +2000,7 @@ class OneAndOneNodeDriver(NodeDriver): List all servers that are being monitoried by the policy :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :return: List of servers being monitored :rtype: ``list`` of ``dict`` @@ -2013,10 +2018,10 @@ class OneAndOneNodeDriver(NodeDriver): Adds servers to monitoring policy :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param servers: List of server ID - :rtype: ``list`` of ``str`` + :type servers: ``list`` of ``str`` :return: Instance of a monitoring policy :rtype: ``dict`` @@ -2037,10 +2042,10 @@ class OneAndOneNodeDriver(NodeDriver): Removes a server from monitoring policy :param policy_id: Id of the monitoring policy - :rtype: ``str`` + :type policy_id: ``str`` :param server_id: Id of the server - :rtype: ``str`` + :type server_id: ``str`` :return: Instance of a monitoring policy :rtype: ``dict``
