Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 5.0

Skip to end of metadata
Go to start of metadata

Configure Networker

To configure networker, do the following steps:

  1. Design your backup system with two 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 workflows – one workflow for each site using backup (with or without replication/clone action)
    • The Abiquo integration supports Complete backups only and it does not manage Networker policies.

Configure Networker properties

To configure the Networker backup integration properties:

  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 "#".

# 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

# 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=


# 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=


# 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
#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.
     
abiquo.backup.networker.config.path=/opt/abiquo/config/networker.properties


Table of plugin properties


NameRequiredTypeDefault valueReloadable
abiquo.networker.backup.ondemand.policytrueString
true
abiquo.networker.backup.ondemand.policy.replicationtrueString
true
abiquo.networker.backup.workflow.replicationAtrueString
true
abiquo.networker.backup.workflow.replicationBtrueString
true
abiquo.networker.cache.expire.durationfalseLong90false
abiquo.networker.cache.expire.timeunitfalseTimeUnitminutesfalse
abiquo.networker.client.debuglogfalseBooleanfalsefalse
abiquo.networker.client.tracker.intervalfalseLong1false
abiquo.networker.client.tracker.timeoutfalseLong30false
abiquo.networker.client.tracker.timeunitfalseTimeUnitminutesfalse
abiquo.networker.client.verifysslfalseBooleanfalsefalse
abiquo.networker.config.reload.periodfalseLong60false
abiquo.networker.config.reload.timeunitfalseTimeUnitminutesfalse
abiquo.networker.credentials.splitter.passfalseString#true
abiquo.networker.credentials.splitter.userfalseString#true
abiquo.networker.results.safetyrange.amountfalseLong15true
abiquo.networker.results.safetyrange.chronounitfalseChronoUnitminutestrue
abiquo.networker.siteA (beta)trueString
true
abiquo.networker.siteA.hoststrueList
true
abiquo.networker.siteB (beta)trueString
true
abiquo.networker.siteB.hoststrueList
true
abiquo.networker.vcenter.hostnametrueString
false
abiquo.networker.vcenter.portfalseinteger443true


Description of plugin properties

For on-demand backups, to indicate which policy to execute depending on the user request, set the following properties:

  • abiquo.networker.backup.ondemand.policy=policyName
  • abiquo.networker.backup.ondemand.policy.replication=policyName

To indicate the name of the workflow inside a policy used to backup to one site or the other, set:

  • abiquo.networker.backup.workflow.replicationA=workflow  
  • abiquo.networker.backup.workflow.replicationB=workflow

To identify the sites of the VMs, define a list of the hypervisor machine names at each site with the following properties:

  • abiquo.networker.siteA.hosts=esxi1.example.com,esxi2.example.com
  • abiquo.networker.siteB.hosts=esxi3.example.com,esxi4.example.com

The configuration properties could require changes every time a new host is added to infrastructure or a policy name is changed in NetWorker, so the plugin integration reloads them in order to avoid a tomcat restart. Only the properties defined as reloadable will be reloaded. To configure when the properties will be reloaded, set:

  • abiquo.networker.config.reload.period=60
  • abiquo.networker.config.reload.timeunit=minutes 

On demand backup and restore operations are tracked by a job. To configure the tracking and set a timeout to fail a job if it appears it will not finish, set the properties starting with: 

  • abiquo.networker.client.tracker.