Configure Networker
...
- Design your backup system with sites, which can be two sites, or dual/stretched sites
- For each site make a list of the hypervisor names (in Abiquo), e.g. esxi1.example.com, esxi2.example.com
- Create one policy with two multiple workflows – one workflow for each site using backup (with or without replication/clone action)
...
- Log in to the Abiquo Remote Services server.
- 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.
- Enter the properties as described here. Default values are set and optional properties are commented out with a hash mark "#".
Code Block |
---|
|
# 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:
Log in to the Abiquo Remote Services server
- Edit the abiquo.properties file.
- Set the path to the plugin properties file using the following property.
...
Table of plugin properties
Name |
| Default value | Required | Type |
---|
Default value | Reloadable |
---|
abiquo.networker.backup.ondemand.policy |
truePolicy name for on-demand backups without replication |
|  | String |
true |
abiquo.networker.backup.ondemand.policy.replication | Policy Name for on-demand backups with replication |
true
|  | String |
true |
abiquo.networker.backup.workflow.replicationA |
trueWorkflow within a policy to back up to for replication of site A |
|  | String |
true |
abiquo.networker.backup.workflow.replicationB |
true | Workflow within a policy to back up to for replication of site B |
|  | String |  |
abiquo.networker.backup.workflow.replicationC | Workflow within a policy to back up to for replication of site C |
|  | String |  |
abiquo.networker.backup.workflow.replicationD | Workflow within a policy to back up to for replication of site D |
|  | String |
true |
abiquo.networker.cache.expire.duration |
falsefalseDuration to store cache of Networker data | 90 |  | Long |
90 |  |
abiquo.networker.cache.expire.timeunit |
falseTime unit for duration to store cache of Networker data | minutes |  | TimeUnit |
minutesfalse | abiquo.networker.client.debuglog | If true, log debug information for Networker client | false |  | Boolean |
false | falsefalse |  |
abiquo.networker.client.timeout.connectionms | Optional timeouts for client to connect to networker API, with default of 10 seconds. To disable the timeout, set the value to 0 | 10000 |  | Long |  |
abiquo.networker.client.timeout.readms | Optional timeouts for client to read from networker API, with default of 10 seconds. To disable the timeout, set the value to 0 | 10000 |  | Long |  |
abiquo.networker.client.timeout.writems | Optional timeouts for client to write to networker API, with default of 10 seconds. To disable the timeout, set the value to 0 | 10000 |  | Long |  |
abiquo.networker.client.tracker.interval |
false | Long | 1 | Track on-demand backup and restore operations at this interval in the configured time unit | 1 |  | Long |  |
abiquo.networker.client.tracker.timeout |
false | Fail on-demand backup and restore operations after no response in the configured time unit | 30 |  | Long |
30false | abiquo.networker.client.tracker.timeunit |
false | Time unit for tracking on-demand backup and restore operations | minutes |  | TimeUnit |
minutesfalse | falseabiquo.networker.client.verifyssl | If true, verify SSL for Networker client | false |  | Boolean |
false |  |
abiquo.networker.config.reload.period |
falsefalse | Period for reloading the properties that are reloadable to avoid tomcat restarts | 60 |  | Long |
60 |  |
abiquo.networker.config.reload.timeunit |
falseTime unit for period for reloading properties that are reloadable to avoid tomcat restarts | minutes |  | TimeUnit |
minutesfalse | abiquo.networker.credentials.splitter.pass |
false | Optional character to split passwords for backup system and vCenter (to restore undeployed VMs) | # |  | String |
#true | abiquo.networker.credentials.splitter.user |
falseOptional character to split users for backup system and vCenter (to restore undeployed VMs) | # |  | String |
#true | abiquo.networker.results.safetyrange.amount |
falsetrue | Optional results safety range time value | 15 |  | Long |
15 |  |
abiquo.networker.results.safetyrange.chronounit |
false | ChronoUnit | minutes | true | Optional results safety range time unit | minutes |  | ChronoUnit |  |
abiquo.networker.siteA | Define storage of results for the site in Abiquo |
|  | String |  |
abiquo.networker.siteA |
(beta)true | String | truesiteAabiquo.networker.siteB (beta) | true | String | truetrue | List | true | siteBtrueList 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. |
|  | List |
true |
abiquo.networker.vcenter.hostname |
trueHost name of the vCenter used with the Networker backup tool |
|  | String |
false |
abiquo.networker.vcenter.port | Optional port |
falsetrue of the vCenter used with the Networker backup tool
| 443 |  | integer |
443 | Description of plugin properties
...