vas.gemfire¶

`AgentInstances`¶

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

Bases: vas.shared.Instance.Instance

An agent instance

Variables:

group (vas.gemfire.Groups.Group) – The group that contains this instance
installation (vas.gemfire.Installations.Installation) – The installation that this instance is using
live_configurations (vas.gemfire.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.gemfire.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()¶: 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)[source]¶

Update he instance to use a different installation

Parameters:	installation (vas.gemfire.Installations.Installation) – The installation that the instance should use

class vas.gemfire.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)[source]¶

Creates a new agent instance

Parameters:	installation (vas.gemfire.Installations.Installation) – The installation to be used by the instance name (str) – The name of the instance
Return type:	:class`vas.gemfire.AgentInstances.AgentInstance`
Returns:	The new agent instance

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

`AgentLiveConfigurations`¶

class vas.gemfire.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.gemfire.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.gemfire.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.gemfire.AgentLogs.AgentLog[source]¶

Bases: vas.shared.Logs.Log

A log file in an agent node instance

Variables:	instance (vas.gemfire.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.gemfire.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.gemfire.AgentNodeInstances.AgentNodeInstance[source]¶

Bases: vas.shared.NodeInstances.NodeInstance

A agent node instance

Variables:

group_instance (vas.gemfire.AgentInstances.AgentInstance) – The node instance’s group instance
live_configurations (vas.gemfire.AgentLiveConfigurations.AgentLiveConfigurations) – The node instance’s live configuration
logs (vas.gemfire.AgentLogs.AgentLogs) – The instance’s logs
name (str) – The instance’s name
node (vas.gemfire.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()¶: Reloads the resource’s details from the server

start()¶: Starts the resource

stop()¶: Stops the resource

class vas.gemfire.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.gemfire.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.gemfire.AgentLiveConfigurations.AgentLiveConfiguration) – The node configuration’s group configuration
instance (vas.gemfire.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.gemfire.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.gemfire.AgentPendingConfigurations.AgentPendingConfiguration[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A agent configuration file that is pending

Variables:	content (str) – The configuration’s content instance (vas.gemfire.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.gemfire.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

`ApplicationCode`¶

class vas.gemfire.ApplicationCode.ApplicationCode[source]¶

Bases: vas.shared.Resource.Resource

Application code in a cache server instance

Variables:

application_code_image (vas.gemfire.ApplicationCodeImages.ApplicationCodeImage) – The image that was used to create the application code
instance (vas.gemfire.CacheServerInstances.CacheServerInstance) – The cache server instance that contains the application code
name (str) – The name of the application code
security (vas.shared.Security.Security) – The resource’s security
version (str) – The version of the application code

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

`ApplicationCodeImages`¶

class vas.gemfire.ApplicationCodeImages.ApplicationCodeImage[source]¶

Bases: vas.shared.Resource.Resource, vas.shared.Deletable.Deletable

An application code image

Variables:

live_application_code (list) – The live application code that has been created from this application code image
name (str) – The application code image’s name
pending_application_code (list) – The pending application code that has been created from this application code image
security (vas.shared.Security.Security) – The resource’s security
size (int) – The application code image’s size
version (str) – The application code image’s version

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

reload()[source]¶: Reloads the application code image’s details from the server

class vas.gemfire.ApplicationCodeImages.ApplicationCodeImages[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete GemFire application code images

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

create(path, name, version)[source]¶

Creates a new application code image by uploading a file and assigning it a name and version

Parameters:	path (str) – The path of the file to upload name (str) – The name of the application code version (str) – The version of the application code
Return type:	`vas.gemfire.ApplicationCodeImages.ApplicationCodeImage`
Returns:	The new application code image

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

`CacheServerInstances`¶

class vas.gemfire.CacheServerInstances.CacheServerInstance[source]¶

Bases: vas.shared.Instance.Instance

A cache server instance

Variables:

group (vas.gemfire.Groups.Group) – The group that contains this instance
installation (vas.gemfire.Installations.Installation) – The installation that this instance is using
live_application_code (vas.gemfire.LiveApplicationCodes.LiveApplicationCodes) – The instance’s live application code
live_configurations (vas.gemfire.CacheServerLiveConfigurations.CacheServerLiveConfigurations) – The instance’s live configurations
name (str) – The instance’s name
node_instances (list) – The instance’s individual node instances
pending_application_code (vas.gemfire.PendingApplicationCodes.PendingApplicationCodes) – The instance’s pending application code
pending_configurations (vas.gemfire.CacheServerPendingConfigurations.CacheServerPendingConfigurations) – 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()¶: 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)[source]¶

Updates the instance to use a different installation

Parameters:	installation (vas.gemfire.Installations.Installation) – The installation that the instance should use

class vas.gemfire.CacheServerInstances.CacheServerInstances[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete cache server instances

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

create(installation, name)[source]¶

Creates a new cache server instance

Parameters:	installation (vas.gemfire.Installations.Installation) – The installation to be used by the instance name (str) – The name of the instance
Return type:	`vas.gemfire.CacheServerInstances.CacheServerInstance`
Returns:	The new cache server instance

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

`CacheServerLiveConfigurations`¶

class vas.gemfire.CacheServerLiveConfigurations.CacheServerLiveConfiguration[source]¶

Bases: vas.shared.LiveConfiguration.LiveConfiguration

A live configuration file in a cache server instance

Variables:

content (str) – The configuration’s content
instance (vas.gemfire.CacheServerInstances.CacheServerInstance) – 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.gemfire.CacheServerLiveConfigurations.CacheServerLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a cache server instance’s live configuration

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

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

`CacheServerLogs`¶

class vas.gemfire.CacheServerLogs.CacheServerLog[source]¶

Bases: vas.shared.Logs.Log

A log file in a cache server node instance

Variables:	instance (vas.gemfire.CacheServerNodeInstances.CacheServerNodeInstance) – 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.gemfire.CacheServerLogs.CacheServerLogs[source]¶

Bases: vas.shared.Logs.Logs

Used to enumerate a cache server node instance’s logs

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

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

`CacheServerNodeInstances`¶

class vas.gemfire.CacheServerNodeInstances.CacheServerNodeInstance[source]¶

Bases: vas.shared.NodeInstances.NodeInstance

A cache server node instance

Variables:

disk_stores (vas.gemfire.DiskStores.DiskStores) – The instance’s disk stores
group_instance (vas.gemfire.CacheServerInstances.CacheServerInstance) – The node instance’s group instance
live_configurations (vas.gemfire.CacheServerLiveConfigurations.CacheServerLiveConfigurations) – The node instance’s live configuration
logs (vas.gemfire.CacheServerLogs.CacheServerLogs) – The instance’s logs
name (str) – The instance’s name
node (vas.gemfire.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
statistics (vas.gemfire.Statistics.Statistics) – The instance’s statistics

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

start(rebalance=None)[source]¶

Starts the resource

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

stop()¶: Stops the resource

class vas.gemfire.CacheServerNodeInstances.CacheServerNodeInstances[source]¶

Bases: vas.shared.NodeInstances.NodeInstances

Used to enumerate cache 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

`CacheServerNodeLiveConfigurations`¶

class vas.gemfire.CacheServerNodeLiveConfigurations.CacheServerNodeLiveConfiguration[source]¶

Bases: vas.shared.NodeConfiguration.NodeConfiguration

A live configuration file in a cache server node instance

Variables:

content (str) – The configuration’s content
group_configuration (vas.gemfire.CacheServerLiveConfigurations.CacheServerLiveConfiguration) – The node configuration’s group configuration
instance (vas.gemfire.CacheServerNodeInstances.CacheServerNodeInstance) – 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.gemfire.CacheServerNodeLiveConfigurations.CacheServerNodeLiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a cache 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

`CacheServerPendingConfigurations`¶

class vas.gemfire.CacheServerPendingConfigurations.CacheServerPendingConfiguration[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A cache server configuration file that is pending

Variables:	content (str) – The configuration’s content instance (vas.gemfire.CacheServerInstances.CacheServerInstance) – 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.gemfire.CacheServerPendingConfigurations.CacheServerPendingConfigurations[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfigurations

Used to enumerate a cache 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

`DiskStores`¶

class vas.gemfire.DiskStores.DiskStore[source]¶

Bases: vas.shared.Resource.Resource, vas.shared.Deletable.Deletable

A disk store in a cache server node instance

Variables:

content (str) – The disk store’s content
instance (vas.gemfire.CacheServerNodeInstances.CacheServerNodeInstance) – The disk store’s cache server node instance
last_modified (datetime.datetime) – The last modified stamp of the disk store
name (str) – the name of the disk store
security (vas.shared.Security.Security) – The resource’s security
size (int) – The size of the disk store

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

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

class vas.gemfire.DiskStores.DiskStores[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Provides access to a cache server node instance’s disk stores

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

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

`GemFire`¶

class vas.gemfire.GemFire.GemFire[source]¶

Bases: object

The entry point to the API for administering GemFire

Variables:	application_code_images (vas.gemfire.ApplicationCodeImages) – The collection of application code images groups (vas.gemfire.Groups) – The collection of groups installation_images (vas.gemfire.InstallationImages) – The collection of installation images nodes (vas.gemfire.Nodes) – The collection of nodes

`Groups`¶

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

Bases: vas.shared.Groups.MutableGroup

A GemFire group

Variables:

agent_instances (vas.gemfire.AgentInstances.AgentInstances) – The group’s agent instances
cache_server_instances (vas.gemfire.CacheServerInstances.CacheServerInstances) – The group’s cache server instances
installations (vas.gemfire.Installations.Installations) – The group’s installations
locator_instances (vas.gemfire.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

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.gemfire.Groups.Groups[source]¶

Bases: vas.shared.Groups.Groups

Used to enumerate, create, and delete GemFire 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.gemfire.InstallationImages.InstallationImage[source]¶

Bases: vas.shared.InstallationImages.InstallationImage

A GemFire installation image

Variables:	installations (vas.gemfire.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.gemfire.InstallationImages.InstallationImages[source]¶

Bases: vas.shared.InstallationImages.InstallationImages

Used to enumerate, create, and delete GemFire 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.gemfire.Installations.Installation[source]¶

Bases: vas.shared.Installations.Installation

A GemFire installation

Variables:

agent_instances (list) – The agent instances that are using the installation
cache_server_instances (list) – The cache server instances that are using the installation
group (vas.gemfire.Groups.Group) – The group that contains the installation
installation_image (vas.gemfire.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
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.gemfire.Installations.Installations[source]¶

Bases: vas.shared.Installations.Installations

Used to enumerate, create, and delete GemFire 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

`LiveApplicationCodes`¶

class vas.gemfire.LiveApplicationCodes.LiveApplicationCodes[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate a cache server’s live application code

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

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

`LocatorInstances`¶

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

Bases: vas.shared.Instance.Instance

A locator instance

Variables:

address (str) – The address of the network card on which the locator will listen
group (vas.gemfire.Groups.Group) – The group that contains this instance
installation (vas.gemfire.Installations.Installation) – The installation that this instance is using
live_configurations (vas.gemfire.LocatorLiveConfigurations.LocatorLiveConfigurations) – The instance’s live configurations
name (str) – The instance’s name
node_instances (list) – The instance’s individual node instances
peer (bool) – True if the locator should act as a peer, otherwise False
pending_configurations (vas.gemfire.LocatorPendingConfigurations.LocatorPendingConfigurations) – The instance’s pending configurations
port (int) – The port that the locator will listen on
security (vas.shared.Security.Security) – The resource’s security
server (bool) – True if the locator should act as a server, otherwise False
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, address=None, peer=None, port=None, server=None)[source]¶

Updates the instance using the supplied options

Parameters:

installation (vas.gemfire.Installations.Installation) – The installation to be used by the instance. If omitted or None, the installation configuration will not be changed.
address (str) – The property in a node’s metadata to use to determine the address that the locator instance will bind to. If omitted or null, the configuration will not be changed. If an empty string is specified, the locator instance will bind to the default network address. If omitted or None, the address configuration will not be changed.
peer (bool) – True if the locator should act as a peer, otherwise False. If omitted or None, the peer configuration will not be changed.
port (int) – The port that the locator will listen on. If omitted or None, the port configuration will not be changed
server (bool) – True if the locator should act as a server, otherwise False. If omitted or None, the server configuration will not be changed.

class vas.gemfire.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, address=None, peer=None, port=None, server=None)[source]¶

Creates a new locator instance

Parameters:	installation (vas.gemfire.Installations.Installation) – The installation that the instance will use name (str) – The name of the locator group instance address (str) – The property in a node’s metadata to use to determine the address that the locator instance will bind to. If omitted or null, the configuration will not be changed. If an empty string is specified, the locator instance will bind to the default network address. peer (bool) – True if the locator should act as a peer, otherwise False port (int) – The port that the locator will listen on server (bool) – True if the locator should act as a server, otherwise False
Return type:	`vas.gemfire.LocatorInstances.LocatorInstance`
Returns:	The new instance

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

`LocatorLiveConfigurations`¶

class vas.gemfire.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.gemfire.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.gemfire.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.gemfire.LocatorLogs.LocatorLog[source]¶

Bases: vas.shared.Logs.Log

A log file in a locator node instance

Variables:	instance (vas.gemfire.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.gemfire.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.gemfire.LocatorNodeInstances.LocatorNodeInstance[source]¶

Bases: vas.shared.NodeInstances.NodeInstance

A locator node instance

Variables:

address (str) – The address of the network card on which the locator will listen
group_instance (vas.gemfire.LocatorInstances.LocatorInstance) – The node instance’s group instance
live_configurations (vas.gemfire.LocatorLiveConfigurations.LocatorLiveConfigurations) – The node instance’s live configuration
logs (vas.gemfire.LocatorLogs.LocatorLogs) – The instance’s logs
name (str) – The instance’s name
node (vas.gemfire.Nodes.Nodes) – The node that contains this instance
peer (bool) – True` if the locator will act as a peer, False if it will not
port (int) – The port that the locator will listen on
security (vas.shared.Security.Security) – The resource’s security
server (bool) – True if the locator will act as a server, False if it will not
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()¶: Starts the resource

stop()¶: Stops the resource

class vas.gemfire.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.gemfire.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.gemfire.LocatorLiveConfigurations.LocatorLiveConfiguration) – The node configuration’s group configuration
instance (vas.gemfire.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.gemfire.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.gemfire.LocatorPendingConfigurations.LocatorPendingConfiguration[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A locator configuration file that is pending

Variables:	content (str) – The configuration’s content instance (vas.gemfire.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.gemfire.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.gemfire.Nodes.Node[source]¶

Bases: vas.shared.Nodes.GroupableNode

A GemFire node

Variables:

agent_home (str) – The location of the vFabric Administration Agent
agent_instances (vas.gemfire.AgentNodeInstances.AgentNodeInstances) – The node’s agent instances
architecture (str) – The architecture of the node’s operating system
cache_server_instances (vas.gemfire.CacheServerNodeInstances.CacheServerNodeInstances) – The node’s cache server instances
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.gemfire.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

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.gemfire.Nodes.Nodes[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate GemFire nodes

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

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

`PendingApplicationCodes`¶

class vas.gemfire.PendingApplicationCodes.PendingApplicationCode[source]¶

Bases: vas.gemfire.ApplicationCode.ApplicationCode, vas.shared.Deletable.Deletable

An application code that is pending

Variables:

application_code_image (vas.gemfire.ApplicationCodeImages.ApplicationCodeImage) – The image that was used to create the application code
instance (vas.gemfire.CacheServerInstances.CacheServerInstance) – The cache server instance that contains the application code
name (str) – The name of the application code
security (vas.shared.Security.Security) – The resource’s security
version (str) – The version of the application code

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

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

class vas.gemfire.PendingApplicationCodes.PendingApplicationCodes[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete a cache server’s pending application code

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

create(image)[source]¶

Creates a new pending application code

Parameters:	image (vas.gemfire.ApplicationCodeImages.ApplicationCodeImage) – The image to create the application code from
Return type:	`vas.gemfire.PendingApplicationCodes.PendingApplicationCode`
Returns:	The new application code

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

`Statistics`¶

class vas.gemfire.Statistics.Statistic[source]¶

Bases: vas.shared.Resource.Resource, vas.shared.Deletable.Deletable

A statistic of a cache server

Variables:

content (str) – The statistic’s content
instance (vas.gemfire.CacheServerNodeInstances.CacheServerNodeInstance) – The statistic’s cache server node instance
last_modified (datetime.datetime) – The last modified stamp of the statistic
path (str) – the path of the statistic
security (vas.shared.Security.Security) – The resource’s security
size (int) – The size of the statistic

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

class vas.gemfire.Statistics.Statistics[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate and delete a cache server’s statistics

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

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

vas.gemfire¶

`AgentInstances`¶

`AgentLiveConfigurations`¶

`AgentLogs`¶

`AgentNodeInstances`¶

`AgentNodeLiveConfigurations`¶

`AgentPendingConfigurations`¶

`ApplicationCode`¶

`ApplicationCodeImages`¶

`CacheServerInstances`¶

`CacheServerLiveConfigurations`¶

`CacheServerLogs`¶

`CacheServerNodeInstances`¶

`CacheServerNodeLiveConfigurations`¶

`CacheServerPendingConfigurations`¶

`DiskStores`¶

`GemFire`¶

`Groups`¶

`InstallationImages`¶

`Installations`¶

`LiveApplicationCodes`¶

`LocatorInstances`¶

`LocatorLiveConfigurations`¶

`LocatorLogs`¶

`LocatorNodeInstances`¶

`LocatorNodeLiveConfigurations`¶

`LocatorPendingConfigurations`¶

`Nodes`¶

`PendingApplicationCodes`¶

`Statistics`¶

Table Of Contents

Previous topic

Next topic

Navigation

vas.gemfire¶

AgentInstances¶

AgentLiveConfigurations¶

AgentLogs¶

AgentNodeInstances¶

AgentNodeLiveConfigurations¶

AgentPendingConfigurations¶

ApplicationCode¶

ApplicationCodeImages¶

CacheServerInstances¶

CacheServerLiveConfigurations¶

CacheServerLogs¶

CacheServerNodeInstances¶

CacheServerNodeLiveConfigurations¶

CacheServerPendingConfigurations¶

DiskStores¶

GemFire¶

Groups¶

InstallationImages¶

Installations¶

LiveApplicationCodes¶

LocatorInstances¶

LocatorLiveConfigurations¶

LocatorLogs¶

LocatorNodeInstances¶

LocatorNodeLiveConfigurations¶

LocatorPendingConfigurations¶

Nodes¶

PendingApplicationCodes¶

Statistics¶

Table Of Contents

Previous topic

Next topic

Quick search

Navigation

`AgentInstances`¶

`AgentLiveConfigurations`¶

`AgentLogs`¶

`AgentNodeInstances`¶

`AgentNodeLiveConfigurations`¶

`AgentPendingConfigurations`¶

`ApplicationCode`¶

`ApplicationCodeImages`¶

`CacheServerInstances`¶

`CacheServerLiveConfigurations`¶

`CacheServerLogs`¶

`CacheServerNodeInstances`¶

`CacheServerNodeLiveConfigurations`¶

`CacheServerPendingConfigurations`¶

`DiskStores`¶

`GemFire`¶

`Groups`¶

`InstallationImages`¶

`Installations`¶

`LiveApplicationCodes`¶

`LocatorInstances`¶

`LocatorLiveConfigurations`¶

`LocatorLogs`¶

`LocatorNodeInstances`¶

`LocatorNodeLiveConfigurations`¶

`LocatorPendingConfigurations`¶

`Nodes`¶

`PendingApplicationCodes`¶

`Statistics`¶