virtual_servers

VirtualServers

class stingray.config.virtual_servers.VirtualServers(host=None, port=None, user=None, password=None, api_version=None, ssl_verify=None)[source]

Bases: stingray.apiclient.Client

Class for interacting with Virtual Servers via the REST API

add(server, pool, port, **server_props)[source]

Add a new virtual server.

Parameters:
  • server (str) – The virtual server name
  • pool (str) – The default pool to use for traffic
  • port (int) – The port to listen on
  • server_props (dict) –

    Additional arguments to set the properties of the virtual server at time of creation. Must be a dict in the form of:

    {'section': {'key': 'value'}}
Returns:

The new virtual server
Return type:

(VirtualServer)
delete(server)[source]

Delete a virtual server

Parameters:server (str) – The name of the virtual server to delete
Returns:Response from the _api_delete method
Return type:(dict)
classmethod from_client(client)[source]
get(server)[source]

Get a VirtualServer object for the requested virtual server

Parameters:server (str) – The name of the virtual server to get
Returns:The requested virtual server
Return type:(VirtualServer)

VirtualServer

class stingray.config.virtual_servers.VirtualServer(server_name, server_path=None, server_properties=None, host=None, port=None, user=None, password=None, api_version=None, ssl_verify=None)[source]

Bases: stingray.apiclient.Client

Class for interacting with individual virtual servers via the REST API

classmethod from_client(client, server_name, server_path=None, server_properties=None)[source]
statistics()[source]

Get statistics for the virtual server

Returns:Virtual server statistics
Return type:(dict)