Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 5.0.1 - release -

Table of Contents

...

  1. Design your backup system with sites, which can be two sites, or dual/stretched sites
  2. For each site make a list of the hypervisor names (in Abiquo), e.g. esxi1.example.com, esxi2.example.com
  3. Create one policy with two multiple workflows – one workflow for each site using backup (with or without replication/clone action)

...

  1. Log in to the Abiquo Remote Services server. 
  2. Go to the /opt/abiquo/config folder and create a networker.properties file. This is the default location, but you can configure your own file as required.
  3. Enter the properties as described here. Default values are set and optional properties are commented out with a hash mark "#".


Code Block
languagejsapplescript
# Host name of the vCenter used with the Networker backup tool
abiquo.networker.vcenter.hostname=

# Optional port of the vCenter used with the Networker backup tool 
# Reloadable property
#abiquo.networker.vcenter.port=443


# Define storage of results for the site in Abiquo
# Reloadable property
abiquo.networker.siteA=
abiquo.networker.siteB=
abiquo.networker.siteC=
abiquo.networker.siteD=


# List of hosts to define site A (which is the group of VMs on these hypervisors to back up), separated by commas.
# Enter hypervisor machine names, for example, "esxi1,.example.com,esxi2.example.com".
# Reloadable property
abiquo.networker.siteA.hosts=

# List of hosts to define site B (which is the group of VMs on these hypervisors to back up), separated by commas.
# Enter hypervisor machine names, for example, "esxi3,.example.com,esxi4.example.com".
# Reloadable property
abiquo.networker.siteB.hosts=


# List of hosts for dual / stretched sites; used in the same way as properties for site A and site B
# Reloadable properties
abiquo.networker.siteC.hosts=
abiquo.networker.siteD.hosts=


# Policy Name for on-demand backups without replication. 
# Reloadable property
abiquo.networker.backup.ondemand.policy=

# Policy Name for on-demand backups with replication. 
# Reloadable property
abiquo.networker.backup.ondemand.policy.replication=


# Workflow within a policy to back up to for replication of site A. 
# Reloadable property
abiquo.networker.backup.workflow.replicationA=

# Workflow within a policy to back up to for replication of site B. 
# Reloadable property
abiquo.networker.backup.workflow.replicationB=



# Workflow within a policy to back up to replication of dual / stretched sites; used in the same way as properties for site A and site B
# Reloadable properties
abiquo.networker.backup.workflow.replicationC=
abiquo.networker.backup.workflow.replicationD= 



# Optional timeouts for client to connect, read, and write with networker API, with default of 10 seconds. To disable a timeout, set the value to 0 
# Reloadable properties
#abiquo.networker.client.timeout.connectionms=10000
#abiquo.networker.client.timeout.readms=10000
#abiquo.networker.client.timeout.writems=10000



# Track on-demand backup and restore operations at this interval
# in the configured time unit
#abiquo.networker.client.tracker.interval=1

# Fail on-demand backup and restore operations after no response
# in the configured time unit
#abiquo.networker.client.tracker.timeout=30

# Time unit for tracking on-demand backup and restore operations
#abiquo.networker.client.tracker.timeunit=minutes


# Duration to store cache of Networker data
#abiquo.networker.cache.expire.duration=90

# Time unit for duration to store cache of Networker data
#abiquo.networker.cache.expire.duration=minutes


# Period for reloading the properties that are reloadable to avoid tomcat restarts
#abiquo.networker.config.reload.period=60

# Time unit for period for reloading properties that are reloadable to avoid
# tomcat restarts
#abiquo.networker.config.reload.timeunit=minutes


# If true, log debug information for Networker client
# Reloadable property
#abiquo.networker.client.debuglog=false


# If true, verify SSL for Networker client
#abiquo.netwoker.client.verifyssl=false




# Optional results safety range time value
# Reloadable property
#abiquo.networker.results.safetyrange.amount=15


# Optional results safety range time unit
# Reloadable property
#abiquo.networker.results.safetyrange.chronounit=minutes


# Optional character to split users for backup system and vCenter (to restore undeployed VMs)
# Reloadable property
#abiquo.networker.credentials.splitter.user=#


# Optional character to split passwords for backup system and vCenter (to restore undeployed VMs)
# Reloadable property
#abiquo.networker.credentials.splitter.pass=#


Configure Abiquo Properties

To activate the Networker plugin and define the location of the configuration file:

  1. Log in to the Abiquo Remote Services server

  2. Edit the abiquo.properties file. 
  3. Set the path to the plugin properties file using the following property.
     

...

Table of plugin properties


Name
Default valueRequiredType
Default value
Reloadable
abiquo.networker.backup.ondemand.policy
true
Policy name for on-demand backups without replication
(tick)String
true
(tick)
abiquo.networker.backup.ondemand.policy.replication
true
Policy Name for on-demand backups with replication
(tick)String
true
(tick)
abiquo.networker.backup.workflow.replicationA
true
Workflow within a policy to back up to for replication of site A
(tick)String
true
(tick)
abiquo.networker.backup.workflow.replicationB
true
Workflow within a policy to back up to for replication of site B
(tick)String(tick)
abiquo.networker.backup.workflow.replicationCWorkflow within a policy to back up to for replication of site C
(tick)String(tick)
abiquo.networker.backup.workflow.replicationDWorkflow within a policy to back up to for replication of site D
(tick)String
true
(tick)
abiquo.networker.cache.expire.duration
false
Duration to store cache of Networker data90(error)Long
90
(error)
false
abiquo.networker.cache.expire.timeunit
false
Time unit for duration to store cache of Networker dataminutes(error)TimeUnit
minutes
(error)
false
abiquo.networker.client.debuglogIf true, log debug information for Networker clientfalse(error)Boolean
falsefalseLong
(tick)
abiquo.networker.client.timeout.connectionmsOptional timeouts for client to connect to networker API, with default of 10 seconds. To disable the timeout, set the value to 010000(error)Long(tick)
abiquo.networker.client.timeout.readmsOptional timeouts for client to read from networker API, with default of 10 seconds. To disable the timeout, set the value to 010000(error)Long(tick)
abiquo.networker.client.timeout.writemsOptional timeouts for client to write to networker API, with default of 10 seconds. To disable the timeout, set the value to 010000(error)Long(tick)
abiquo.networker.client.tracker.interval
false

Track on-demand backup and restore operations at this interval
in the configured time unit

1
false
(error)Long(error)
abiquo.networker.client.tracker.timeout
falsefalse

Fail on-demand backup and restore operations after no response in the configured time unit

30(error)Long
30
(error)
abiquo.networker.client.tracker.timeunit
falsefalse
Time unit for tracking on-demand backup and restore operationsminutes(error)TimeUnit
minutesfalse
(error)
abiquo.networker.client.verifysslIf true, verify SSL for Networker clientfalse(error)Boolean
false
(error)
abiquo.networker.config.reload.period
false

Period for reloading the properties that are reloadable to avoid tomcat restarts

60(error)Long
60
(error)
false
abiquo.networker.config.reload.timeunit
false

Time unit for period for reloading properties that are reloadable to avoid tomcat restarts

minutes(error)TimeUnit
minutes
(error)
false
abiquo.networker.credentials.splitter.pass
false
Optional character to split passwords for backup system and vCenter (to restore undeployed VMs)#(error)String
#
(tick)
true
abiquo.networker.credentials.splitter.user
falsetrue

Optional character to split users for backup system and vCenter (to restore undeployed VMs)

#(error)String
#
(tick)
abiquo.networker.results.safetyrange.amount
false
Optional results safety range time value15(error)Long
15
(tick)
true
abiquo.networker.results.safetyrange.chronounit
falseChronoUnitminutestrue
Optional results safety range time unitminutes(error)ChronoUnit(tick)
abiquo.networker.siteADefine storage of results for the site in Abiquo
(tick)String(tick)
abiquo.networker.siteA
(beta)trueStringtrue
.hosts

List of hosts to define site A, separated by commas. Enter the machine names of the hypervisors (for example, "esxi1.example.com,esxi2.example.com") that contain the VMs to back up.


(tick)List(tick)
abiquo.networker.siteBDefine storage of results for the site in Abiquo
(tick)String(tick)
abiquo.networker.
siteA.hoststrueListtrueabiquo.networker.siteB (beta)trueStringtrue
siteB.hosts

List of hosts to define site B, separated by commas. Enter the machine names of the hypervisors (for example, "esxi3.example.com,esxi4.example.com") that contain the VMs to back up.


(tick)List(tick)
abiquo.networker.siteCDefine storage of results for the site in Abiquo
(tick)String(tick)
abiquo.networker.siteC.hosts

List of hosts to define site C, separated by commas. Enter the machine names of the hypervisors (for example, "esxi5.example.com,esxi6.example.com") that contain the VMs to back up.


(tick)List(tick)
abiquo.networker.siteDDefine storage of results for the site in Abiquo
(tick)String(tick)
abiquo.networker.
siteB.hoststrueListtrue
siteD.hosts

List of hosts to define site D, separated by commas. Enter the machine names of the hypervisors (for example, "esxi7.example.com,esxi8.example.com") that contain the VMs to back up.


(tick)List(tick)
abiquo.networker.vcenter.hostname
true
Host name of the vCenter used with the Networker backup tool
(tick)String
false
(error)
abiquo.networker.vcenter.portOptional port
falsetrue
of the vCenter used with the Networker backup tool
443(error)integer
443
(tick)

Description of plugin properties

...