vas.sqlfire¶

`AgentInstances`¶

class vas.sqlfire.AgentInstances.AgentInstance[source]¶

Bases: vas.shared.Instance.Instance

An agent instance

Variables:

group (vas.sqlfire.Groups.Group) – The group that contains this instance
installation (vas.sqlfire.Installations.Installation) – The installation that this instance is using
jvm_options (list) – The JVM options that are passed to the agent’s JVM when it is started
live_configurations (vas.sqlfire.AgentLiveConfigurations.AgentLiveConfigurations) – The instance’s live configurations
name (str) – The instance’s name
node_instances (list) – The instance’s individual node instances
pending_configurations (vas.sqlfire.AgentPendingConfigurations.AgentPendingConfigurations) – The instance’s pending configurations
security (vas.shared.Security.Security) – The resource’s security
state (str) –
Retrieves the state of the resource from the server. Will be one of:
- STARTING
- STARTED
- STOPPING
- STOPPED

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()[source]¶: Reloads the agent instance’s details from the server

start(serial=False)¶

Starts the resource

Parameters:	serial (bool) – Whether to start the node instance serially

stop(serial=False)¶

Stops the resource

Parameters:	serial (bool) – Whether to stop the node instance serially

update(installation=None, jvm_options=None)[source]¶

Updates the instance

Parameters:	installation (vas.sqlfire.Installations.Installation) – The installation to be used by the instance. If omitted or None, the configuration will not be changed jvm_options (list) – The JVM options that are passed to the agent’s JVM when it is started. If omitted or None, the configuration will not be changed

class vas.sqlfire.AgentInstances.AgentInstances[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete agent instances

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(installation, name, jvm_options=None)[source]¶

Creates a new agent instance

Parameters:	installation (vas.sqlfire.Installations.Installation) – The installation ot be used by the instance name (str) – The name of the instances jvm_options (list) – The JVM options that are based to the agent’s JVM when it is started
Return type:	`vas.sqlfire.AgentInstances.AgentInstance`
Returns:	The new agent instance

reload()¶: Reloads the resource’s details from the server

`AgentLiveConfigurations`¶

class vas.sqlfire.AgentLiveConfigurations.AgentLiveConfiguration[source]¶

Bases: vas.shared.LiveConfiguration.LiveConfiguration

A live configuration file in a agent instance

Variables:

content (str) – The configuration’s content
instance (vas.sqlfire.AgentInstances.AgentInstance) – The instance that owns the configuration
path (str) – The configuration’s path
node_configurations (list) – The configuration’s node configurations
security (vas.shared.Security.Security) – The resource’s security
size (int) – The configuration’s size

reload()¶: Reloads the live configuration’s details from the server

class vas.sqlfire.AgentLiveConfigurations.AgentLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a agent instance’s live configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`AgentLogs`¶

class vas.sqlfire.AgentLogs.AgentLog[source]¶

Bases: vas.shared.Logs.Log

A log file in an agent node instance

Variables:	instance (vas.sqlfire.AgentNodeInstances.AgentNodeInstance) – The node instance that the log belongs to last_modified (datetime.datetime) – The last modified stamp of the log name (str) – The name of the log security (vas.shared.Security.Security) – The resource’s security size (int) – The size of the log

content(start_line=None, end_line=None)¶

Get the content of the log

Parameters:	start_line (int) – The start point, in lines, of the content to return. A value of `None` will result in content from the start of the file being returned. If the provided value is greater than the number of lines in the file, the returned content will be empty. end_line (int) – The end point, in lines, of the content to return. A value of `None` will result in content up to the end of the file being returned. If the provided value is greater than the number of lines in the file, content up to and including the last line in the file will be returned.
Return type:	`str`
Returns:	The root directory of the extracted agent

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the log’s details from the server

class vas.sqlfire.AgentLogs.AgentLogs[source]¶

Bases: vas.shared.Logs.Logs

Used to enumerate an agent node instance’s logs

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`AgentNodeInstances`¶

class vas.sqlfire.AgentNodeInstances.AgentNodeInstance[source]¶

Bases: vas.shared.NodeInstances.NodeInstance

An agent node instance

Variables:

group_instance (vas.sqlfire.AgentInstances.AgentInstance) – The node instance’s group instance
jvm_options (list) – The JVM options that are passed to the agent’s JVM when it is started
live_configurations (vas.sqlfire.AgentNodeLiveConfigurations.AgentNodeLiveConfigurations) – The node instance’s live configuration
logs (vas.sqlfire.AgentLogs.AgentLogs) – The instance’s logs
name (str) – The instance’s name
node (vas.sqlfire.Nodes.Nodes) – The node that contains this instance
security (vas.shared.Security.Security) – The resource’s security
state (str) –
Retrieves the state of the resource from the server. Will be one of:
- STARTING
- STARTED
- STOPPING
- STOPPED

reload()[source]¶: Reloads the agent instance’s details from the server

start()¶: Starts the resource

stop()¶: Stops the resource

class vas.sqlfire.AgentNodeInstances.AgentNodeInstances[source]¶

Bases: vas.shared.NodeInstances.NodeInstances

Used to enumerate agent instances on an individual node

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`AgentNodeLiveConfigurations`¶

class vas.sqlfire.AgentNodeLiveConfigurations.AgentNodeLiveConfiguration[source]¶

Bases: vas.shared.NodeConfiguration.NodeConfiguration

A live configuration file in a agent node instance

Variables:

content (str) – The configuration’s content
group_configuration (vas.sqlfire.AgentLiveConfigurations.AgentLiveConfiguration) – The node configuration’s group configuration
instance (vas.sqlfire.AgentNodeInstances.AgentNodeInstance) – The instance the owns the configuration
path (str) – The configuration’s path
security (vas.shared.Security.Security) – The resource’s security
size (int) – The configuration’s size

reload()¶: Reloads the configuration’s details from the server

class vas.sqlfire.AgentNodeLiveConfigurations.AgentNodeLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a agent node instance’s live configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`AgentPendingConfigurations`¶

class vas.sqlfire.AgentPendingConfigurations.AgentPendingConfiguration[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A agent configuration file that is pending

Variables:	content (str) – The configuration’s content instance (vas.sqlfire.AgentInstances.AgentInstance) – The instance that owns the configuration path (str) – The configuration’s path security (vas.shared.Security.Security) – The resource’s security size (int) – The configuration’s size

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the configuration’s details from the server

class vas.sqlfire.AgentPendingConfigurations.AgentPendingConfigurations[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfigurations

Used to enumerate a agent instance’s pending configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(path, content)¶

Creates a new configuration. The configuration will be pending until its instance is started at which point the configuration will become live.

Parameters:	path (str) – The configuration’s path content (str) – The configuration’s content
Return type:	`vas.shared.PendingConfigurations.PendingConfiguration`
Returns:	The new configuration

reload()¶: Reloads the resource’s details from the server

`Groups`¶

class vas.sqlfire.Groups.Group[source]¶

Bases: vas.shared.Groups.MutableGroup

A SqlFire group

Variables:

agent_instances (vas.sqlfire.AgentInstances.AgentInstances) – The group’s agent instances
installations (vas.sqlfire.Installations.Installations) – The group’s installations
locator_instances (vas.sqlfire.LocatorInstances.LocatorInstances) – The group’s locator instances
name (str) – The group’s name
nodes (list) – The group’s nodes
security (vas.shared.Security) – The resource’s security
server_instances (vas.sqlfire.ServerInstances.ServerInstances) – The group’s server instances

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the group’s details from the server

update(nodes)¶

Update the group to contain the given nodes

Parameters:	nodes (list) – The group’s nodes

class vas.sqlfire.Groups.Groups[source]¶

Bases: vas.shared.Groups.Groups

Used to enumerate, create, and delete SqlFire groups

Variables:	security (vas.shared.Security.Security) – The security configuration for the collection

create(name, nodes)¶

Creates a new group

Parameters:	name (str) – The group’s name nodes (list) – The group’s nodes
Return type:	`vas.shared.Groups.Group`
Returns:	The new group

reload()¶: Reloads the resource’s details from the server

`InstallationImages`¶

class vas.sqlfire.InstallationImages.InstallationImage[source]¶

Bases: vas.shared.InstallationImages.InstallationImage

A SqlFire installation image

Variables:	installations (vas.sqlfire.Installations.Installations) – The installations that have been created from the installation image security (vas.shared.Security.Security) – The resource’s security size (int) – The installation image’s size version (str) – The installation image’s version

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the installation image’s details from the server

class vas.sqlfire.InstallationImages.InstallationImages[source]¶

Bases: vas.shared.InstallationImages.InstallationImages

Used to enumerate, create, and delete SqlFire installation images

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(path, version)¶

Creates an installation image by uploading a file to the server and assigning it a version

Parameters:	path (str) – The path of the file to upload version (str) – The installation image’s version
Return type:	`vas.shared.InstallationImages.InstallationImage`
Returns:	The new installation image

reload()¶: Reloads the resource’s details from the server

`Installations`¶

class vas.sqlfire.Installations.Installation[source]¶

Bases: vas.shared.Installations.Installation

A SqlFire installation

Variables:

agent_instances (list) – The agent instances that are using the installation
group (vas.sqlfire.Groups.Group) – The group that contains the installation
installation_image (vas.sqlfire.InstallationImages.InstallationImage) – The installation image that was used to create the installation
locator_instances (list) – The locator instances that are using the installation
security (vas.shared.Security.Security) – The resource’s security
server_instances (list) – The server instances that are using the installation
version (str) – The installation’s version

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()[source]¶: Reloads the installation’s details from the server

class vas.sqlfire.Installations.Installations[source]¶

Bases: vas.shared.Installations.Installations

Used to enumerate, create, and delete SqlFire installations

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(installation_image)¶

Create a new installation

Parameters:	installation_image (`vas.shared.InstallationImages.InstallationImage`) – The installation image to use to create the installation
Return type:	`vas.shared.Installations.Installation`
Returns:	The new installation

reload()¶: Reloads the resource’s details from the server

`LocatorInstances`¶

class vas.sqlfire.LocatorInstances.LocatorInstance[source]¶

Bases: vas.shared.Instance.Instance

A locator instance

Variables:

bind_address (str) – The property in a node’s metadata used to determine the address that the locator binds to for peer-to-peer communication. If None,the locator uses the value derived from peer_discovery_address.
client_bind_address (str) – The property in a node’s metadata used to determine the address that the locator binds to for client communication. If None, the locator uses the node’s hostname. Only takes effect if run_netserver is True.
client_port (int) – The port that the locator listens on for client connections. Only takes effect if run_netserver is True.
group (vas.sqlfire.Groups.Group) – The group that contains this instance
installation (vas.sqlfire.Installations.Installation) – The installation that this instance is using
initial_heap (str) – The initial heap size of the locator’s JVM. If None the default is used.
jvm_options (list) – The JVM options that are passed to the locator’s JVM when it is started
live_configurations (vas.sqlfire.LocatorLiveConfigurations.LocatorLiveConfigurations) – The instance’s live configurations
max_heap (str) – The max heap size of the locator’s JVM. If None the default is used.
name (str) – The instance’s name
node_instances (list) – The instance’s individual node instances
peer_discovery_address (str) – The property in a node’s metadata used to determine the address that the locator binds to for peer-discovery communication. If None, the locator uses 0.0.0.0.
peer_discovery_port (port) – The port that the locator listens on for peer-discovery connections
pending_configurations (vas.sqlfire.LocatorPendingConfigurations.LocatorPendingConfigurations) – The instance’s pending configurations
run_netserver (bool) – True if the locator runs a netserver that can service thin clients, otherwise False.
security (vas.shared.Security.Security) – The resource’s security
state (str) –
Retrieves the state of the resource from the server. Will be one of:
- STARTING
- STARTED
- STOPPING
- STOPPED

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()[source]¶: Reloads the locator instance’s details from the server

start(serial=False)¶

Starts the resource

Parameters:	serial (bool) – Whether to start the node instance serially

stop(serial=False)¶

Stops the resource

Parameters:	serial (bool) – Whether to stop the node instance serially

update(installation=None, bind_address=None, client_bind_address=None, client_port=None, initial_heap=None, jvm_options=None, max_heap=None, peer_discovery_address=None, peer_discovery_port=None, run_netserver=None)[source]¶

Updates the locator instance

Parameters:	installation (vas.sqlfire.Installations.Installation) – The installation that the instance will use bind_address (str) – The property in a node’s metadata to use to determine the address that the locator binds to for peer-to-peer communication. If omitted, or if the property does not exist, the locator will use the value derived from `peer-discovery-address`. client_bind_address (str) – The property in a node’s metadata to use to determine the address that the locator binds to for client communication. If omitted, or if the property does not exist, the locator will use the node’s hostname. Only takes effect if `run-netserver` is True. client_port (int) – The port that the locator listens on for client connections. Only takes effect if `run-netserver` is True. initial_heap (str) – The initial heap size to be used by the locator’s JVM. If not specified, the JVM’s default is used. jvm_options (list) – The JVM options that are passed to the locator’s JVM when it is started max_heap (str) – The maximum heap size to be used by the locator’s JVM. If not specified, the JVM’s default is used. peer_discovery_address (str) – The property in a node’s metadata to use to determine the address that the locator binds to for peer-discovery communication. If omitted, or if the property does not exist, the locator will use `0.0.0.0`. peer_discovery_port (int) – The port that the locator listens on for peer-discovery connections. If omitted, the locator will listen on the default port (10334). run_netserver (bool) – Whether the locator should run a netserver that can service thin clients. Default is True.
Return type:	`vas.sqlfire.LocatorInstances.LocatorInstance`
Returns:	The new instance

class vas.sqlfire.LocatorInstances.LocatorInstances[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete locator instances

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(installation, name, bind_address=None, client_bind_address=None, client_port=None, initial_heap=None, jvm_options=None, max_heap=None, peer_discovery_address=None, peer_discovery_port=None, run_netserver=None)[source]¶

Creates a new locator instance

Parameters:	installation (vas.sqlfire.Installations.Installation) – The installation that the instance will use name (str) – The name of the instance bind_address (str) – The property in a node’s metadata to use to determine the address that the locator binds to for peer-to-peer communication. If omitted, or if the property does not exist, the locator will use the value derived from `peer-discovery-address`. client_bind_address (str) – The property in a node’s metadata to use to determine the address that the locator binds to for client communication. If omitted, or if the property does not exist, the locator will use the node’s hostname. Only takes effect if `run-netserver` is True. client_port (int) – The port that the locator listens on for client connections. Only takes effect if `run-netserver` is True. initial_heap (str) – The initial heap size to be used by the locator’s JVM. If not specified, the JVM’s default is used. jvm_options (list) – The JVM options that are passed to the locator’s JVM when it is started max_heap (str) – The maximum heap size to be used by the locator’s JVM. If not specified, the JVM’s default is used. peer_discovery_address (str) – The property in a node’s metadata to use to determine the address that the locator binds to for peer-discovery communication. If omitted, or if the property does not exist, the locator will use `0.0.0.0`. peer_discovery_port (int) – The port that the locator listens on for peer-discovery connections. If omitted, the locator will listen on the default port (10334). run_netserver (bool) – Whether the locator should run a netserver that can service thin clients. Default is True.
Return type:	`vas.sqlfire.LocatorInstances.LocatorInstance`
Returns:	The new instance

reload()¶: Reloads the resource’s details from the server

`LocatorLiveConfigurations`¶

class vas.sqlfire.LocatorLiveConfigurations.LocatorLiveConfiguration[source]¶

Bases: vas.shared.LiveConfiguration.LiveConfiguration

A live configuration file in a locator instance

Variables:

content (str) – The configuration’s content
instance (vas.sqlfire.LocatorInstances.LocatorInstance) – The instance that owns the configuration
path (str) – The configuration’s path
node_configurations (list) – The configuration’s node configurations
security (vas.shared.Security.Security) – The resource’s security
size (int) – The configuration’s size

reload()¶: Reloads the live configuration’s details from the server

class vas.sqlfire.LocatorLiveConfigurations.LocatorLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a locator instance’s live configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`LocatorLogs`¶

class vas.sqlfire.LocatorLogs.LocatorLog[source]¶

Bases: vas.shared.Logs.Log

A log file in a locator node instance

Variables:	instance (vas.sqlfire.LocatorNodeInstances.LocatorNodeInstance) – The node instance that the log belongs to last_modified (datetime.datetime) – The last modified stamp of the log name (str) – The name of the log security (vas.shared.Security.Security) – The resource’s security size (int) – The size of the log

content(start_line=None, end_line=None)¶

Get the content of the log

Parameters:	start_line (int) – The start point, in lines, of the content to return. A value of `None` will result in content from the start of the file being returned. If the provided value is greater than the number of lines in the file, the returned content will be empty. end_line (int) – The end point, in lines, of the content to return. A value of `None` will result in content up to the end of the file being returned. If the provided value is greater than the number of lines in the file, content up to and including the last line in the file will be returned.
Return type:	`str`
Returns:	The root directory of the extracted agent

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the log’s details from the server

class vas.sqlfire.LocatorLogs.LocatorLogs[source]¶

Bases: vas.shared.Logs.Logs

Used to enumerate a locator node instance’s logs

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`LocatorNodeInstances`¶

class vas.sqlfire.LocatorNodeInstances.LocatorNodeInstance[source]¶

Bases: vas.shared.NodeInstances.NodeInstance

A locator node instance

Variables:

bind_address (str) – The property in a node’s metadata used to determine the address that the locator binds to for peer-to-peer communication. If None,the locator uses the value derived from peer_discovery_address.
client_bind_address (str) – The property in a node’s metadata used to determine the address that the locator binds to for client communication. If None, the locator uses the node’s hostname. Only takes effect if run_netserver is True.
client_port (int) – The port that the locator listens on for client connections. Only takes effect if run_netserver is True.
group_instance (vas.sqlfire.LocatorInstances.LocatorInstance) – The node instance’s group instance
initial_heap (str) – The initial heap size of the locator’s JVM. If None the default is used.
jvm_options (list) – The JVM options that are passed to the locator’s JVM when it is started
live_configurations (vas.sqlfire.LocatorNodeLiveConfigurations.LocatorNodeLiveConfigurations) – The node instance’s live configuration
logs (vas.sqlfire.LocatorLogs.LocatorLogs) – The instance’s logs
max_heap (str) – The max heap size of the locator’s JVM. If None the default is used.
name (str) – The instance’s name
node (vas.sqlfire.Nodes.Node) – The node that contains this instance
peer_discovery_address (str) – The property in a node’s metadata used to determine the address that the locator binds to for peer-discovery communication. If None, the locator uses 0.0.0.0.
peer_discovery_port (port) – The port that the locator listens on for peer-discovery connections
run_netserver (bool) – True if the locator runs a netserver that can service thin clients, otherwise False.
security (vas.shared.Security.Security) – The resource’s security
state (str) –
Retrieves the state of the resource from the server. Will be one of:
- STARTING
- STARTED
- STOPPING
- STOPPED

reload()[source]¶: Reloads the locator node instance’s details from the server

start()¶: Starts the resource

stop()¶: Stops the resource

class vas.sqlfire.LocatorNodeInstances.LocatorNodeInstances[source]¶

Bases: vas.shared.NodeInstances.NodeInstances

Used to enumerate locator instances on an individual node

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`LocatorNodeLiveConfigurations`¶

class vas.sqlfire.LocatorNodeLiveConfigurations.LocatorNodeLiveConfiguration[source]¶

Bases: vas.shared.NodeConfiguration.NodeConfiguration

A live configuration file in a locator node instance

Variables:

content (str) – The configuration’s content
group_configuration (vas.sqlfire.LocatorLiveConfigurations.LocatorLiveConfiguration) – The node configuration’s group configuration
instance (vas.sqlfire.LocatorNodeInstances.LocatorNodeInstance) – The instance the owns the configuration
path (str) – The configuration’s path
security (vas.shared.Security.Security) – The resource’s security
size (int) – The configuration’s size

reload()¶: Reloads the configuration’s details from the server

class vas.sqlfire.LocatorNodeLiveConfigurations.LocatorNodeLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a locator node instance’s live configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`LocatorPendingConfigurations`¶

class vas.sqlfire.LocatorPendingConfigurations.LocatorPendingConfiguration[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A locator configuration file that is pending

Variables:	content (str) – The configuration’s content instance (vas.sqlfire.LocatorInstances.LocatorInstance) – The instance that owns the configuration path (str) – The configuration’s path security (vas.shared.Security.Security) – The resource’s security size (int) – The configuration’s size

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the configuration’s details from the server

class vas.sqlfire.LocatorPendingConfigurations.LocatorPendingConfigurations[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfigurations

Used to enumerate a locator instance’s pending configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(path, content)¶

Creates a new configuration. The configuration will be pending until its instance is started at which point the configuration will become live.

Parameters:	path (str) – The configuration’s path content (str) – The configuration’s content
Return type:	`vas.shared.PendingConfigurations.PendingConfiguration`
Returns:	The new configuration

reload()¶: Reloads the resource’s details from the server

`Nodes`¶

class vas.sqlfire.Nodes.Node[source]¶

Bases: vas.shared.Nodes.GroupableNode

A SqlFire node

Variables:

agent_home (str) – The location of the vFabric Administration Agent
agent_instances (vas.sqlfire.AgentNodeInstances.AgentNodeInstances) – The node’s agent instances
architecture (str) – The architecture of the node’s operating system
groups (list) – The groups that contain this node
host_names (list) – The node’s host names
ip_addresses (list) – The node’s IP addresses
ipv4_addresses (list) – The node’s IPv4 addresses
ipv6_addresses (list) – The node’s IPv6 addresses
locator_instances (vas.sqlfire.LocatorNodeInstances.LocatorNodeInstances) – The node’s locator instances
metadata (dict) – The node’s metadata
operating_system (str) – The node’s operating system
security (vas.shared.Security.Security) – The resource’s security
server_instances (vas.sqlfire.ServerNodeInstances.ServerNodeInstances) – The node’s server instances

reload()[source]¶: Reloads the node’s details from the server

update(metadata)¶

Updates the node’s metadata

Parameters:	metadata (dict) – The node’s new metadata

class vas.sqlfire.Nodes.Nodes[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate SqlFire nodes

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`ServerInstances`¶

class vas.sqlfire.ServerInstances.ServerInstance[source]¶

Bases: vas.shared.Instance.Instance

A server instance

Variables:

bind_address (str) – The property in a node’s metadata used to determine the address that the server binds to for peer-to-peer communication. If None, the server uses the node’s hostname.
client_bind_address (str) – the property in a node’s metadata used to determine the address that the server binds to for client communication. If None, the server uses localhost. Only takes effect if run_netserver is True.
client_port (int) – the port that the server listens on for client connections. Only takes effect if run_netserver is True.
critical_heap_percentage (int) – Critical heap percentage as a percentage of the old generation heap. If None the server uses the default.
group (vas.sqlfire.Groups.Group) – The group that contains this instance
initial_heap (str) – The initial heap size of the server’s JVM. If None the default is used.
installation (vas.sqlfire.Installations.Installation) – The installation that this instance is using
jvm_options (list) – The JVM options that are passed to the server’s JVM when it is started
live_configurations (vas.sqlfire.ServerLiveConfigurations.ServerLiveConfigurations) – The instance’s live configurations
max_heap (str) – The max heap size of the server’s JVM. If None the default is used.
name (str) – The instance’s name
node_instances (list) – The instance’s individual node instances
pending_configurations (vas.sqlfire.ServerPendingConfigurations.ServerPendingConfigurations) – The instance’s pending configurations
run_netserver (bool) – True if the server runs a netserver that can service thin clients, otherwise False
security (vas.shared.Security.Security) – The resource’s security
state (str) –
Retrieves the state of the resource from the server. Will be one of:
- STARTING
- STARTED
- STOPPING
- STOPPED

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()[source]¶: Reloads the instance’s details from the server

start(serial=False)¶

Starts the resource

Parameters:	serial (bool) – Whether to start the node instance serially

stop(serial=False)¶

Stops the resource

Parameters:	serial (bool) – Whether to stop the node instance serially

update(installation=None, bind_address=None, client_bind_address=None, client_port=None, critical_heap_percentage=None, initial_heap=None, jvm_options=None, max_heap=None, run_netserver=None)[source]¶

Updates the instance

Parameters:	installation (vas.sqlfire.Installations.Installation) – The installation that the instance will use bind_address (str) – The property in a node’s metadata to use to determine the address that the server binds to for peer-to-peer communication. If omitted, or if the property does not exist, the server will use the node’s hostname. client_bind_address (str) – The property in a node’s metadata to use to determine the address that the server binds to for client communication. If omitted, or if the property does not exist, the server will use the node’s hostname. Only takes effect if `run-netserver` is True. client_port (int) – The port that the server listens on for client connections. Only takes effect if `run-netserver` is True. critical_heap_percentage (int) – Critical heap threshold as a percentage of the old generation heap initial_heap (str) – The initial heap size to be used by the server’s JVM. If not specified, the JVM’s default is used jvm_options (list) – The JVM options that are passed to the server’s JVM when it is started max_heap (str) – The maximum heap size to be used by the server’s JVM. If not specified, the JVM’s default is used run_netserver (bool) – Whether the locator should run a netserver that can service thin clients. Default is True.
Return type:	`vas.sqlfire.ServerInstances.ServerInstance`
Returns:	The new server instance

class vas.sqlfire.ServerInstances.ServerInstances[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete server instances

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(installation, name, bind_address=None, client_bind_address=None, client_port=None, critical_heap_percentage=None, initial_heap=None, jvm_options=None, max_heap=None, run_netserver=None)[source]¶

Creates a new server instance

Parameters:	installation (vas.sqlfire.Installations.Installation) – The installation that the instance will use name (str) – The name of the instance bind_address (str) – The property in a node’s metadata to use to determine the address that the server binds to for peer-to-peer communication. If omitted, or if the property does not exist, the server will use the node’s hostname. client_bind_address (str) – The property in a node’s metadata to use to determine the address that the server binds to for client communication. If omitted, or if the property does not exist, the server will use the node’s hostname. Only takes effect if `run-netserver` is True. client_port (int) – The port that the server listens on for client connections. Only takes effect if `run-netserver` is True. critical_heap_percentage (int) – Critical heap threshold as a percentage of the old generation heap initial_heap (str) – The initial heap size to be used by the server’s JVM. If not specified, the JVM’s default is used jvm_options (list) – The JVM options that are passed to the server’s JVM when it is started max_heap (str) – The maximum heap size to be used by the server’s JVM. If not specified, the JVM’s default is used run_netserver (bool) – Whether the locator should run a netserver that can service thin clients. Default is True.
Return type:	`vas.sqlfire.ServerInstances.ServerInstance`
Returns:	The new server instance

reload()¶: Reloads the resource’s details from the server

`ServerLiveConfigurations`¶

class vas.sqlfire.ServerLiveConfigurations.ServerLiveConfiguration[source]¶

Bases: vas.shared.LiveConfiguration.LiveConfiguration

A live configuration file in a server instance

Variables:

content (str) – The configuration’s content
instance (vas.sqlfire.ServerInstances.ServerInstance) – The instance that owns the configuration
path (str) – The configuration’s path
node_configurations (list) – The configuration’s node configurations
security (vas.shared.Security.Security) – The resource’s security
size (int) – The configuration’s size

reload()¶: Reloads the live configuration’s details from the server

class vas.sqlfire.ServerLiveConfigurations.ServerLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a server instance’s live configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`ServerLogs`¶

class vas.sqlfire.ServerLogs.ServerLog[source]¶

Bases: vas.shared.Logs.Log

A log file in a server node instance

Variables:	instance (vas.sqlfire.ServerNodeInstances.ServerNodeInstance) – The node instance that the log belongs to last_modified (datetime.datetime) – The last modified stamp of the log name (str) – The name of the log security (vas.shared.Security.Security) – The resource’s security size (int) – The size of the log

content(start_line=None, end_line=None)¶

Get the content of the log

Parameters:	start_line (int) – The start point, in lines, of the content to return. A value of `None` will result in content from the start of the file being returned. If the provided value is greater than the number of lines in the file, the returned content will be empty. end_line (int) – The end point, in lines, of the content to return. A value of `None` will result in content up to the end of the file being returned. If the provided value is greater than the number of lines in the file, content up to and including the last line in the file will be returned.
Return type:	`str`
Returns:	The root directory of the extracted agent

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the log’s details from the server

class vas.sqlfire.ServerLogs.ServerLogs[source]¶

Bases: vas.shared.Logs.Logs

Used to enumerate a server node instance’s logs

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`ServerNodeInstances`¶

class vas.sqlfire.ServerNodeInstances.ServerNodeInstance[source]¶

Bases: vas.shared.NodeInstances.NodeInstance

A server node instance

Variables:

bind_address (str) – The property in a node’s metadata used to determine the address that the server binds to for peer-to-peer communication. If None, the server uses the node’s hostname.
client_bind_address (str) – the property in a node’s metadata used to determine the address that the server binds to for client communication. If None, the server uses localhost. Only takes effect if run_netserver is True.
client_port (int) – the port that the server listens on for client connections. Only takes effect if run_netserver is True.
critical_heap_percentage (int) – Critical heap percentage as a percentage of the old generation heap. If None the server uses the default.
group_instance (vas.sqlfire.ServerInstances.ServerInstance) – The node instance’s group instance
initial_heap (str) – The initial heap size of the server’s JVM. If None the default is used.
jvm_options (list) – The JVM options that are passed to the server’s JVM when it is started
live_configurations (vas.sqlfire.ServerNodeLiveConfigurations.ServerNodeLiveConfigurations) – The node instance’s live configuration
logs (vas.sqlfire.ServerLogs.ServerLogs) – The instance’s logs
max_heap (str) – The max heap size of the server’s JVM. If None the default is used.
name (str) – The instance’s name
run_netserver (bool) – True if the server runs a netserver that can service thin clients, otherwise False
node (vas.sqlfire.Nodes.Node) – The node that contains this instance
security (vas.shared.Security.Security) – The resource’s security
state (str) –
Retrieves the state of the resource from the server. Will be one of:
- STARTING
- STARTED
- STOPPING
- STOPPED

reload()[source]¶: Reloads the instance’s details from the server

start(rebalance=None)[source]¶

Starts the resource

Parameters:	rebalance (bool) – Whether to rebalance the server instance on start

stop()¶: Stops the resource

class vas.sqlfire.ServerNodeInstances.ServerNodeInstances[source]¶

Bases: vas.shared.NodeInstances.NodeInstances

Used to enumerate server instances on an individual node

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`ServerNodeLiveConfigurations`¶

class vas.sqlfire.ServerNodeLiveConfigurations.ServerNodeLiveConfiguration[source]¶

Bases: vas.shared.NodeConfiguration.NodeConfiguration

A live configuration file in a server node instance

Variables:

content (str) – The configuration’s content
group_configuration (vas.sqlfire.ServerLiveConfigurations.ServerLiveConfiguration) – The node configuration’s group configuration
instance (vas.sqlfire.ServerNodeInstances.ServerNodeInstance) – The instance the owns the configuration
path (str) – The configuration’s path
security (vas.shared.Security.Security) – The resource’s security
size (int) – The configuration’s size

reload()¶: Reloads the configuration’s details from the server

class vas.sqlfire.ServerNodeLiveConfigurations.ServerNodeLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a server node instance’s live configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

reload()¶: Reloads the resource’s details from the server

`ServerPendingConfigurations`¶

class vas.sqlfire.ServerPendingConfigurations.ServerPendingConfiguration[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A server configuration file that is pending

Variables:	content (str) – The configuration’s content instance (vas.sqlfire.ServerInstances.ServerInstance) – The instance that owns the configuration path (str) – The configuration’s path security (vas.shared.Security.Security) – The resource’s security size (int) – The configuration’s size

delete()¶: Performs a delete. If a collection is available it is reloaded.

reload()¶: Reloads the configuration’s details from the server

class vas.sqlfire.ServerPendingConfigurations.ServerPendingConfigurations[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfigurations

Used to enumerate a server instance’s pending configuration

Variables:	security (vas.shared.Security.Security) – The resource’s security

create(path, content)¶

Creates a new configuration. The configuration will be pending until its instance is started at which point the configuration will become live.

Parameters:	path (str) – The configuration’s path content (str) – The configuration’s content
Return type:	`vas.shared.PendingConfigurations.PendingConfiguration`
Returns:	The new configuration

reload()¶: Reloads the resource’s details from the server

`SqlFire`¶

class vas.sqlfire.SqlFire.SqlFire[source]¶

Bases: object

The entry point to the API for administering SqlFire

Variables:	groups (vas.sqlfire.Groups) – The collection of groups installation_images (vas.sqlfire.InstallationImages) – The collection of installation images nodes (vas.sqlfire.Nodes) – The collection of nodes

vas.sqlfire¶

`AgentInstances`¶

`AgentLiveConfigurations`¶

`AgentLogs`¶

`AgentNodeInstances`¶

`AgentNodeLiveConfigurations`¶

`AgentPendingConfigurations`¶

`Groups`¶

`InstallationImages`¶

`Installations`¶

`LocatorInstances`¶

`LocatorLiveConfigurations`¶

`LocatorLogs`¶

`LocatorNodeInstances`¶

`LocatorNodeLiveConfigurations`¶

`LocatorPendingConfigurations`¶

`Nodes`¶

`ServerInstances`¶

`ServerLiveConfigurations`¶

`ServerLogs`¶

`ServerNodeInstances`¶

`ServerNodeLiveConfigurations`¶

`ServerPendingConfigurations`¶

`SqlFire`¶

Table Of Contents

Previous topic

Next topic

Navigation

vas.sqlfire¶

AgentInstances¶

AgentLiveConfigurations¶

AgentLogs¶

AgentNodeInstances¶

AgentNodeLiveConfigurations¶

AgentPendingConfigurations¶

Groups¶

InstallationImages¶

Installations¶

LocatorInstances¶

LocatorLiveConfigurations¶

LocatorLogs¶

LocatorNodeInstances¶

LocatorNodeLiveConfigurations¶

LocatorPendingConfigurations¶

Nodes¶

ServerInstances¶

ServerLiveConfigurations¶

ServerLogs¶

ServerNodeInstances¶

ServerNodeLiveConfigurations¶

ServerPendingConfigurations¶

SqlFire¶

Table Of Contents

Previous topic

Next topic

Quick search

Navigation

`AgentInstances`¶

`AgentLiveConfigurations`¶

`AgentLogs`¶

`AgentNodeInstances`¶

`AgentNodeLiveConfigurations`¶

`AgentPendingConfigurations`¶

`Groups`¶

`InstallationImages`¶

`Installations`¶

`LocatorInstances`¶

`LocatorLiveConfigurations`¶

`LocatorLogs`¶

`LocatorNodeInstances`¶

`LocatorNodeLiveConfigurations`¶

`LocatorPendingConfigurations`¶

`Nodes`¶

`ServerInstances`¶

`ServerLiveConfigurations`¶

`ServerLogs`¶

`ServerNodeInstances`¶

`ServerNodeLiveConfigurations`¶

`ServerPendingConfigurations`¶

`SqlFire`¶