· 6 years ago · Sep 10, 2019, 01:54 PM
1Available commands:
2==========
3check_updates_emergency (app)
4Retrieves the available update versions from the configured repository.
5
6 All the *emergency commands should be used only when the service(s) are down
7 and cannot be updated otherwise. The underlying implementation uses vami
8 scripts directly. For this reason emergency commands will not work over the
9 network. They can be invoked only to the local machine.
10
11 Usage: h4cli check_updates_emergency
12
13==========
14get_update_eula_emergency (app)
15Retrieves the available update EULA.
16
17 All the *emergency commands should be used only when the service(s) are down
18 and cannot be updated otherwise. The underlying implementation uses vami
19 scripts directly. For this reason emergency commands will not work over the
20 network. They can be invoked only to the local machine and do not require any
21 authentication or authorization.
22
23 Usage: h4cli get_update_eula_emergency
24
25==========
26get_update_repo_emergency (app)
27Retrieves the currently configured update repository URL.
28
29 All the *emergency commands should be used only when the service(s) are down
30 and cannot be updated otherwise. The underlying implementation uses vami
31 scripts directly. For this reason emergency commands will not work over the
32 network. They can be invoked only to the local machine and do not require any
33 authentication or authorization.
34
35 Usage: h4cli get_update_repo_emergency
36
37==========
38set_custom_update_repo_emergency (app)
39Changes the custom update repository URL. This can be an update repo hosted
40 in the client's infrastructure or an iso attached to the VM as cd-rom. In the
41 latter case 'cdrom://' should be used. Username and password are optional and
42 are only for the former case.
43
44 If set the custom repo will always be preferred to the default repo. To use
45 the default one the custom should be set to an empty string ''.
46
47 All the *emergency commands should be used only when the service(s) are down
48 and cannot be updated otherwise. The underlying implementation uses vami
49 scripts directly. For this reason emergency commands will not work over the
50 network. They can be invoked only to the local machine and do not require any
51 authentication or authorization.
52
53 Usage: h4cli set_custom_update_repo_emergency new_update_repo [username] [password]
54
55==========
56update_emergency (app)
57Updates to the latest available version.
58
59 All the *emergency commands should be used only when the service(s) are down
60 and cannot be updated otherwise. The underlying implementation uses vami
61 scripts directly. For this reason emergency commands will not work over the
62 network. They can be invoked only to the local machine.
63
64 Usage: h4cli update_emergency [timeout]
65
66==========
67about (mgr)
68Returns manager instance id.
69
70==========
71additionalmgr (mgr)
72Completes the pairing of a local replicator to a remote site manager.
73
74 Usage: h4cli additionalmgr 'local replicator id' 'remote mgr url' 'thumbprint' 'pairing cookie'
75
76==========
77archiveInstance (mgr)
78Retrieves an instance by replication id and instance id.
79 Usage: h4cli instance replication-id instance-id
80
81==========
82archivedinstances (mgr)
83Retrieves all archived replication instances by replication Id.
84 Usage: h4cli archivedinstances replication-id
85
86==========
87archiveinstance (mgr)
88Archives an instance by replication id and instance id.
89 Usage: h4cli archiveinstance replication-id instance-id
90
91==========
92bulkreplications (mgr)
93Retrieves the available replications for the logged user.
94 Usage: h4cli replications ids
95 Where:
96 ids is the comma-separated list of replication ids for the replications to retrieve.
97
98==========
99bundles (mgr)
100Lists all support bundles currently available for download from the manager.
101 They are sorted by date of creation in descending order - newly created
102 bundles are first.
103
104==========
105cancelmove (mgr)
106Cancels an ongoing move replica operation.
107 Usage: h4cli cancelmove replication-id
108
109==========
110changedisks (mgr)
111Reconfigures the replicated disks of a VM (a.k.a. include/exclude disks). When a disk is added to a replicated VM the replication
112 is temporary paused, until the user decides whether the new disk should be replicated. By default the disk will be added to the
113 replication. To exclude it use "h4cli replication_id 'excluded_key' '' ''"
114 Usage h4cli changedisks replication_id [excluded_disk_key1,...,excluded_disk_keyN] [validate_seed_uuids] [disk_placement]
115 replication_id id of the replication to be reconfigured
116 excluded_disk_keys disk keys to exclude from replication, e.g. 2000,2001. By default no disks are excluded (all source vm disks will be replicated)
117 validate_seed_uuids whether the source VM disks and seed disks must have matching disk uuids
118 disk_placement format: 'diskKey','datastoreId','diskPath','isSeed'.
119
120==========
121changepw (mgr)
122Changes the manager's appliance password.
123 Usage: h4cli changepw current_password new_password
124
125==========
126check_updates (mgr)
127Retrieves the available update versions from the configured repository.
128 Usage: h4cli checkupdates
129
130==========
131checkhealth (mgr)
132Checks whether we have a good connection to a manager.
133
134==========
135cleanup (mgr)
136Calls 'DELETE replications/replication_id/failover-test'
137 Usage: h4cli cleanup replication_id
138
139==========
140clientauths (mgr)
141Lists all registered client certificates.
142
143==========
144commands (mgr)
145Displays info on the available commands.
146 Usage: h4cli commands
147
148==========
149config (mgr)
150Gets the config for the Manager.
151 Usage: h4cli config
152
153==========
154deletebundle (mgr)
155Delete a support bundle in the manager.
156
157==========
158downloadbundle (mgr)
159Downloads the specified support bundle.
160 Usage: h4cli downloadbundle bundle-id
161
162 Note: this command spawns an external curl process and is quite insecure!
163
164==========
165dumpconfig (mgr)
166Dumps the current configration.
167 Usage: h4cli dumpconfig
168
169==========
170endpoints (mgr)
171Retrieves the current endpoint configuration of the manager. If any of the
172 addresses are empty, this means that they're are detected automatically.
173 Usage: h4cli endpoints
174
175==========
176exportinstance (mgr)
177Calls 'POST replications/replication_id/export-instance'
178 Once the export is completed virtual machine files will be spawned from the given instance.
179 They will be located in the target location. The virtual machine will not be registered in
180 VC or ESXi. The files will be not be part of the replica hierarchy and will not be managed by
181 H4.
182 Usage: h4cli exportinstance replication_id instance_id datastore_id datastore_folder
183 where
184 instance_id is the id of the instance that should be exported
185 datastore_id is the target datastore mo-id.
186 datastore_folder a non-existing folder in the datastore
187
188==========
189failover (mgr)
190Calls 'replications/replication_id/failover'
191 Usage: h4cli failover replication_id [power_on] [placement_settings] [instance_id] [snapshot_options] [custom_hardware]
192 where:
193 power_on (defaults to true) indicates whether the recovered VM should be powered on
194 placement_settings (by default retrieved by MTA) indicates where to locate the recovered VM. Format 'vm_folder,res_pool_id,host_id', all elements are required. Example: vmfolder-group-v3,resgroup-8,host-9
195 instance_id (by default latest instance is used) indicates which instance to use for recovery point
196 snapshot_options (defaults to EXPOSE_PITS) indicates whether the existing preceding PITs should be exposed as snapshots, whether PITs should be consolidated or nothing should happen in the recovered VM. Values: DO_NOTHING, EXPOSE_PITS, CONSOLIDATE
197 custom_hardware (by default recovered vm has the exact same hardware as the original) allows the number of cpus,cores_per_socket,memory_in_mib,mac_address_policy for the recovered VM to be overriden. Valid values for mac_address_policy are 'GENERATE_NEW' and 'DEFAULT'.
198
199==========
200generatebundle (mgr)
201Causes a new manager support bundle to be generated. To download the bundle,
202 use downloadbundle.
203
204==========
205get_local_certificate (mgr)
206Retrieves local certificate.
207 Usage: h4cli get_local_certificate
208
209==========
210get_update_eula (mgr)
211Retrieves the available update EULA.
212 Usage: h4cli getupdateeula
213
214==========
215get_update_repo (mgr)
216Retrieves the currently configured update repository URL.
217 Usage: h4cli get_update_repo
218
219==========
220getcertificate (mgr)
221Retrieves the X509/SSL certificate for the given url.
222 Note: The API is accessible only after SSO authentication. Use "h4cli login" first!
223 Usage: h4cli getcertificate url
224
225==========
226getsites (mgr)
227Retrieves a list of distinct sites, which is alphabetically sorted.
228 Usage: h4cli getsites
229
230==========
231help (mgr)
232Displays the documentation and usage of the given command.
233
234 Usage: h4cli help [command]
235 command - The command to display help for. If omitted, help for all commands is displayed.
236
237==========
238instance (mgr)
239Retrieves an archive instance by replication id and instance id.
240 Usage: h4cli instance replication-id instance-id
241
242==========
243instances (mgr)
244Retrieves all replication instances by replication Id.
245 Usage: h4cli instances replication-id
246
247==========
248isplainlwdallowed (mgr)
249Checks if the manager's plain lwd traffic is allowed (i.e. both unencrypted and noncompressed).
250
251==========
252listdisks (mgr)
253Lists all replicated disks in the given replication
254 Usage h4cli listdisks replication_id
255
256==========
257login (mgr)
258Creates a manager session using the credentials stored in the config file (or overridden on the command line).
259 Usage: h4cli login [principal]
260
261==========
262loginroot (mgr)
263Creates a manager session using the supplied appliance root password
264 Usage: h4cli loginroot 'root password'
265
266==========
267loglevel (mgr)
268Updates the log level setting for a specific logback logger at runtime
269 without requiring a service restart. Note that changes are not persisted
270 across reboots.
271
272 Usage h4cli loglevel com.parent.child.logger [ALL|TRACE|DEBUG|INFO|WARN|ERROR|OFF]
273 Where:
274 logger - logback logger name
275 level - the new log level for the given logger; if no level is given then
276 the log level setting for the logger will be removed.
277
278==========
279loglevels (mgr)
280Retrieves all logback log levels currently in effect for the service.
281
282 Usage h4cli loglevels
283
284==========
285logout (mgr)
286Destroys the current manager session.
287
288==========
289managerhealthinfo (mgr)
290Asks the manager for healthcheck info.
291
292==========
293migrate (mgr)
294Calls 'replications/replication_id/migrate'
295 Usage: h4cli migrate replication_id [power_on] [placement_settings] [expose_snapshots] [consolidate_disks]
296 where:
297 power_on (defaults to true) indicates whether the recovered VM should be powered on
298 placement_settings (by default retrieved by MTA) indicates where to locate the recovered VM. Format 'vm_folder,res_pool_id,host_id'. Example: vmfolder-group-v3,resgroup-8,host-9
299 snapshot_options (defaults to EXPOSE_PITS) indicates whether the existing preceding PITs should be exposed as snapshots, whether PITs should be consolidated or nothing should happen in the recovered VM. Values: DO_NOTHING, EXPOSE_PITS, CONSOLIDATE
300 custom_hardware (by default recovered vm has the exact same hardware as the original) allows the number of cpus,cores_per_socket,memory_in_mib,mac_address_policy for the recovered VM to be overriden. Valid values for mac_address_policy are 'GENERATE_NEW' and 'DEFAULT'.
301
302==========
303network (mgr)
304Obtains the appliance network configuration.
305 Usage: h4cli network
306
307==========
308newclientauth (mgr)
309Registers a new client certificate to h4 manager. Client certificates are
310 used for api authentication and authorization. Currently they are granted
311 admin authorities.
312
313 id - user generated uuid of the client certificate
314 cert - base64 der encoded client certificate
315
316==========
317newrep (mgr)
318Defines a new replicator in the manager. The allowed symbols in the site name are letters, numbers, dash(-) and underscore(_).
319 If API url and the rest of details for replicator are provided the pair happens in one step.
320 Usage: h4cli newrep ownerid siteid "some description" "repurl" "repthumprint" "reppass" "vcuser" "vcpass"
321
322==========
323passwd_expired (mgr)
324Determines if the root password has expired and therefore requires a reset.
325 Usage: h4cli passwd_expired
326
327==========
328pause (mgr)
329Pauses a replication. See also 'resume'.
330 Usage: h4cli pause replication_id
331
332==========
333ping (mgr)
334Checks if the manager's API endpoint is operational.
335
336==========
337polltasks (mgr)
338Retrieves the details for the tasks with the given ids
339 Usage: h4cli polltasks task-uuid task-uuid ...
340
341==========
342pruneinstance (mgr)
343Deletes an instance by replication id and instance id. Pruning is the process of merging two instances,
344 effectively removing one of them. The latest instance cannot be pruned.
345 Usage: h4cli pruneinstance replication-id instance-id
346
347==========
348reboot_os (mgr)
349TODO: write me!
350
351==========
352reboot_services (mgr)
353TODO: write me!
354
355==========
356reconfigure (mgr)
357Reconfigures a replication.
358 Usage h4cli reconfigure replication_id [rpo] [dataConnectionType] [quiesced]
359 replication_id id of the replication to be reconfigured
360 rpo recovery point objective in minutes - if empty/omitted no change will be applied
361 dataConnectionType What LWD traffic mode is supported. Can be PLAIN, ENCRYPTED or ENCRYPTED_COMPRESSED
362 quiesced replicated image guest quiescing - if empty/omitted no change will be applied
363 retention_policy allows you to configure MPIT instances. Format: 'noInstances1,distance1,noInstance2,distance2,...'
364 archive_settings allows users to push instances to an additional datastore. Format: 'datastore_id,datastore_folder,max_instances,max_incremental_instances'.
365 If omitted the existing configuration will not be changed. To disable the archive use 'disable' value.
366
367==========
368regenerate_local_certificate (mgr)
369Generates new local certificate.
370 Usage: h4cli regenerate_local_certificate
371
372==========
373regtunnel (mgr)
374Enables integration with the tunneling service.
375
376 Usage: h4cli regtunnel tunnel_address [tunnel_port=8048]
377
378==========
379removeclientauth (mgr)
380Removes the client certificate with a given id.
381
382==========
383removereplicator (mgr)
384Removes the given replicator from the manager only if there are no active
385 replications, related to the given replicator and if the replicator is owned
386 by the currently logged (impersonated) user.
387 Usage: h4cli removereplicator replicatorId
388
389==========
390removereplicatorbycookie (mgr)
391Removes the half-paired replicator from the manager. If the current user
392 is admin, he can remove replicators, which were paired by anyone. Otherwise -
393 only the ones that were added by him.
394 Usage: h4cli removereplicatorbycookie cookie
395
396==========
397replication (mgr)
398Retrieves a replication by its id.
399 Only replications owned by crrently logged user are visible.
400 Usage: h4cli replication replication-id
401
402==========
403replications (mgr)
404Retrieves a page of replications for the logged in user.
405 Usage: h4cli replications [ids] [overall_health] [data_connection_state] [limit] [offset]
406
407==========
408replicatormaintenance (mgr)
409Enters/exits maintenance mode for a replicator identified by replicatorId.
410 Usage: h4cli replicatormaintenance replicatorId isInMaintenenaceMode
411
412==========
413replicators (mgr)
414Lists all replicators registered in a manager.
415 Only shared replicators or owned by the currently logged user are shown.
416 Usage: h4cli replicators
417
418==========
419resetreplicatorcookie (mgr)
420Tells the manager to generate a new config cookie for the given replicator.
421 This cookie should be given to the replicator so that he can let the manager
422 know that the replicator has a new certificate.
423 usage h4cli resetreplicatorcookie replicator_id
424
425==========
426resume (mgr)
427Resumes a replication. See also 'pause'.
428 Usage: h4cli resume replication_id
429
430==========
431reverse (mgr)
432Reverses the direction of the specified recovered replication.
433 The recovered VM becomes the source VM. The original source VM's disks act
434 as offline copies.
435 The old replication is removed upon success. The original source VM is
436 unregistered from VM upon success.
437 Usage h4cli reverse replication_id
438
439==========
440session (mgr)
441Retrieves the current session details.
442 Usage: h4cli session
443
444==========
445set_custom_update_repo (mgr)
446Changes the custom update repository URL. This can be an update repo hosted
447 in the client's infrastructure or an iso attached to the VM as cd-rom. In the
448 latter case 'cdrom://' should be used. Username and password are optional and
449 are only for the former case.
450
451 If set the custom repo will always be preferred to the default repo. To use
452 the default repo the custom one should be set to an empty string ''.
453
454 Usage: h4cli setupdaterepo new_update_repo [username] [password]
455
456==========
457setdns (mgr)
458Obtains the appliance network configuration.
459 Usage: h4cli setdns ip-addr-1 [ip-addr2] [domain-name] [searchDomain1,...,searchDomainN]
460
461==========
462setendpoints (mgr)
463Updates the manager's endpoint configuration. An empty string means that the
464 given address is detected automatically. If any of the option is not given,
465 it'll be auto detected.
466
467 mgmt_address - the IP address or hostname for HTTPS (management) traffic to advertise to components on the local site.
468 mgmt_port - the port number for HTTPS (management) traffic to advertise to components on the local site.
469 mgmt_public_address - the IP address or hostname for HTTPS (management) traffic to advertise to components on remote sites.
470 mgmt_public_port - the port number for HTTPS (management) traffic to advertise to components on remote sites.
471
472 Usage: h4cli setendpoints mgmt_address mgmt_port mgmt_public_address mgmt_public_port
473
474==========
475sethostname (mgr)
476Updates the virtual appliance hostname.
477 Usage: h4cli sethostname 'host.domain'
478
479==========
480setls (mgr)
481Changes the lookup service of the manager. Requires admin session
482 Usage: h4cli setls url thumbprint
483 To configure the manager to stop using a lookup service: h4cli setls ''
484
485==========
486setnic (mgr)
487Reconfigures the respective Network Interface Card.
488
489 Usage: h4cli setnic eth0 [mode] [ipv4-addr] [ipv4-netmask] [ipv4_gateway] [ipv6-addr] [ipv6-prefix] [ipv6-gateway]
490 Where:
491 eth0 is the name of the NIC in the appliance
492 mode is one of DHCPV4, DHCPV6, AUTOV6, DHCPV4+DHCPV6, DHCPV4+AUTOV6,
493 STATICV4, STATICV4+DHCPV6, STATICV4+AUTOV6, STATICV6,
494 DHCPV4+STATICV6, STATICV4+STATICV6.
495 ipv4-addr is a literal IPv4 addres (only used if mode is STATICV4*)
496 ipv4-netmask is IPv4 netmask like 255.255.255.0 (only used if mode is STATICV4*)
497 ipv4-gateway is an optional literal IPv4 address of a gateway (only used if mode is STATICV4*)
498 ipv6-addr is a literal IPv6 address (only used if mode is *STATICV6)
499 ipv6-prefix is a the IPv6 network prefix (only used if mode is *STATICV6)
500 ipv6-gateway is 'default' or an optional literal IPv6 address (only used if mode is *STATICV6)
501
502==========
503setplainlwdallowed (mgr)
504Sets the value of plain LWD traffic allowed flag. If true both unencrypted and
505 noncompressed traffic will be allowed.
506 Usage: h4cli setplainlwdallowed true/false
507
508==========
509setsite (mgr)
510Sets the site property for the manager (this can only be done once). The allowed symbols in the site name are letters, numbers, dash(-) and underscore(_).
511 Usage: h4cli setsite 'site-short-name'
512
513==========
514showreplicator (mgr)
515Retrieves the details of a single replicator registered in a manager.
516 Only shared replicators or owned by the currently logged user are shown.
517 Usage: h4cli showreplicator replicator_id
518
519==========
520start (mgr)
521Starts a new replication.
522 Usage h4cli start vc_uuid vm_mo_id rpo source_replicator_uuid destination_replicator_uuid [csq] [excluded_disk_key1,...,excluded_disk_keyN] [placement_settings] [retention_policy] [autopin_instances] [archive_settings] [start_paused] [seed_vm_location] [initial_sync_time]
523 vc_uuid source vm vCenter Server instance UUID
524 vm_mo_id source vm managed object id, e.g. vm-18
525 rpo recovery point objective in minutes
526 source_replicator_uuid
527 destination_replicator_uuid
528 csq optional encryption, compression and quiescing flags, c = compressed, s = encrypted, q = quiesced, csq = all [default], n = neither
529 excluded_disk_key disk keys to exclude from replication, e.g. 2000,2001. By default no disks are excluded (all source vm disks will be replicated)
530 placement_settings indicates where to store the replicated data. Format: 'vc_id,datastore_id,datastore_folder,validateSeedUuids[,disk_info*]', First three elements are required. Example: 1510b2ee-1518-11e7-93ae-92361f002671,datastore-11,vmfolder-group-v3,false. Additionality each disk can be explicitly placed by providing disk_info. Format: 'diskKey','datastoreId','diskPath','isSeed'. Example "dcf7b37a-ce52-4e72-a173-dc29b4d3719c,datastore-24,ds_123/,2000,datastore-25,ds_123/disk-2000.vmdk,false".
531 retention_policy allows you to configure MPIT instances. Format: 'noInstances1,distance1,noInstance2,distance2,...'
532 autopin_instances automatically pins all new instaces. Defaults to false.
533 archive_settings optional archive settings. Allows users to push instances to an additional datastore. Format: 'datastore_id,datastore_folder,max_instances,max_incremental_instances'
534 start_paused Starts the replication in paused state. Defaults to false.
535 seed_vm_location VM to use disks for seeding. The format is: "vcid,vmid"
536 initial_sync_time optionally delay the initial sync
537
538==========
539start_by_site (mgr)
540Starts a new replication. Source and destination replicator are determined
541 automatically (based on the given sites).
542 Usage h4cli start_by_site vc_uuid vm_mo_id rpo site_src site_dest
543
544==========
545stop (mgr)
546Stops a replication. Disk cleanup options:
547 REMOVE_ALL - remove all disks, including seeds
548 AUTO - remove all disks, created by h4 (leave seeds untouched) - default option
549 REMOVE_NONE - do not touch the disks, leave them as they are
550 Usage h4cli stop group_id [REMOVE_ALL|REMOVE_NONE|AUTO]
551
552==========
553stop_offline_sync (mgr)
554Calls 'replications/replication_id/stopOfflineSync' to abort an ongoing
555 offline sync (if present).
556
557 Usage: h4cli stop_offline_sync replication_id
558
559==========
560switchdestinationrtr (mgr)
561Switches to a new destination replicator.
562 Usage h4cli switchdestinationrtr replicationId newReplicatorId
563
564==========
565switchsourcertr (mgr)
566Switches to a new source replicator.
567 Usage h4cli switchsourcertr replicationId newReplicatorId
568
569==========
570sync (mgr)
571Calls 'replications/replication_id/sync' to perform a manual sync of the
572 given replication.
573
574 Usage: h4cli sync replication_id
575
576==========
577task (mgr)
578Retrieves the details (from the manager) for the task with the given id.
579 Usage: h4cli task task-id
580
581==========
582tasks (mgr)
583Retrieves a list of tasks, visible to the current user.
584 Usage: h4cli tasks [ids] [user] [state] [start_time_before] [start_time_after] [end_time_before] [end_time_after] [type] [resource_id] [resource_type] [sort] [limit] [offset]
585 Where:
586 ids filters tasks by task uuids (comma separated)
587 user is the user, started the task; filtering is available only to admins
588 state filters tasks by state (one of RUNNING, SUCCEEDED, FAILED)
589 start_time_before filter tasks where the start time is less than the given value
590 start_time_after filter tasks where the start time is greater than the given value
591 end_time_before filter tasks where the end time is less than the given value
592 end_time_after filter tasks where the end time is greater than the given value
593 type filter tasks by task.worfklowInfo.type
594 resource_id filter tasks by task.worfklowInfo.resourceId
595 resource_type filter tasks by task.worfklowInfo.resourceId
596 sort list of comma-separated field names;
597 fields, ending in "-" indicates desc order;
598 supported sorting fields - "user", "state", "startTime", "endTime"
599 limit maximum number of tasks to retrieve
600 offset number of items to skip
601
602==========
603test (mgr)
604Calls 'replications/replication_id/failoverTest'
605 Usage: h4cli test replication_id [power_on] [sync] [placement_settings] [instance_id] [expose_snapshots] [custom_hardware]
606 where:
607 power_on (defaults to true) indicates whether the recovered VM should be powered on
608 sync (defaults to true) whether to sync the latest changes in the replicated VM before performing test recovery
609 placement_settings (by default retrieved by MTA) indicates where to locate the recovered VM. Format 'vm_folder,res_pool_id,host_id', all elements are required. Example: vmfolder-group-v3,resgroup-8,host-9
610 instance_id (by default latest instance is used) indicates which instance to use for recovery point
611 expose_snapshots (defaults to true) indicates whether the previous PIT's should be exposed as snapshots of the recovered VM
612 custom_hardware (by default recovered vm has the exact same hardware as the original) allows the number of cpus,cores_per_socket,memory_in_mib,mac_address_policy for the recovered VM to be overriden. Valid values for mac_address_policy are 'GENERATE_NEW' and 'DEFAULT'.
613
614==========
615trustedhosts (mgr)
616Retrieves a list of hosts, which can be used for failover operations
617 and also for configuring replications.
618
619 Usage: h4cli trustedhosts replicator_id
620 Where:
621 replicator_id is the instance id of a fully paired replicator
622
623==========
624trusthost (mgr)
625Marks the given host as 'trusted'. This allows the host to be used for writing
626 to the datastore during replication time, and it also alows the host to be
627 selected explicitly in failover operations to host the recovered VM.
628
629 Usage: h4cli trusthost replicator_id vc_id host_id
630 Where:
631 replicator_id is the instance id of a fully paired replicator
632 vc_id is the (destination) vCenter instance id
633 host_id is the moid of the host in the specified vCenter
634
635==========
636unregtunnel (mgr)
637Disables integration with the tunneling service.
638
639 Usage: h4cli unregtunnel
640
641==========
642unsetls (mgr)
643Removes the lookup configuration of the manager
644 Usage: h4cli unsetls
645
646==========
647untrusthost (mgr)
648Marks the given host as 'untrusted'. As a result failover operations with
649 explicit placement will fail if no host can see the datastore,
650 specified by the user.
651
652 Usage: h4cli untrusthost replicator_id vc_id host_id
653 Where:
654 replicator_id is the instance id of a fully paired replicator
655 vc_id is the (destination) vCenter instance id
656 host_id is the moid of the host in the specified vCenter
657
658==========
659update (mgr)
660Updates to the latest available version.
661 Usage: h4cli update
662
663==========
664upload_certificate (mgr)
665Replaces the server certificate with the user-provided one.
666 Expected container format is PKCS#12. It must conatin one private key and
667 its associated certificate.
668
669 Usage: h4cli upload_certificate file_path [password]
670 Where file_path is the path to the p12/pfx file
671 password is the PKCS#12 container password; can be omitted if it's empty string
672
673==========
674vcs (mgr)
675Queries the local site for available vCenters..
676
677 Usage: h4cli vcs site
678
679==========
680vm (mgr)
681Returns VM hardware info by querying the replicators on the given site.
682
683 Usage: h4cli vm site vc-instance-uuid vm-mo-id
684
685==========
686vmconfig (mgr)
687Retrieves basic vm config of a replicated vm.
688 Usage: h4cli vmconfig replication-id
689
690==========
691vms (mgr)
692Queries a manager for the inventories for each accessible replicator.
693 Usage: h4cli vms site vcId [name] [ids] [sort] [limit] [offset]
694 site - the site where the vms live
695 vcId - the instanceId of the vCenter instance that manages the vms
696 name - filter the vm whose name contains the given string
697 ids - comma-separated list of vm ids used to filter the result
698 sort - sort the result in asc order by a list comma-separated field names;
699 fields, ending in "-", sort in desc order;
700 supported sorting fields - "name", "cpus", "memory"
701 limit - maximum number of vms to retrieve
702 offset - how much vms to skip
703
704==========
705wait (mgr)
706Similar to the 'task' command, however, if the respective task has not yet
707 completed, it will be polled until it completes.
708 Usage: h4cli wait task-uuid
709
710==========
711waitboot (mgr)
712Waits until the manager boots or a timeout occurs.
713
714==========
715waitinstance (mgr)
716Waits until a replication has an instance.
717 Usage: h4cli waitinstance replication-id
718
719==========
720aboutreplicator (rep)
721Returns replicator instance, management and lwd addreses.
722
723==========
724cloud (rep)
725Returns information about a cloud site this on-prem replicator is paired
726 with.
727
728 Usage: h4cli cloud cloud-id
729
730==========
731deletecloud (rep)
732Forces the local on-prem replicator to "forget" about the cloud.
733 Usage: h4cli delete cloud cloud_id org_user org_password
734
735==========
736destinationreplications (rep)
737Retrieves all destination replications.
738 Usage: h4cli destinationreplications
739
740==========
741lsreg (rep)
742Updates the replicator LookupService registration.
743
744 Usage: h4cli lsreg sso-user sso-password
745 The specified user must have SSO admin privilege
746
747==========
748lsunreg (rep)
749Removes the replicator LookupService registration.
750
751 Usage: h4cli lsunreg sso-user sso-password
752 The specified user must have SSO admin privilege
753
754==========
755managers (rep)
756Returns a list of managers, known to the replicator.
757 Usage: h4cli managers
758
759==========
760managersync (rep)
761Forces state exchange between the replicator and all the paired managers.
762
763==========
764monitoringsession (rep)
765Returns a C4 API key that corresponds to a session that can monitor
766 replications and tasks belonging to the org this on-prem replicator is
767 paired with.
768 Usage: h4cli monitoringsession cloud_id
769
770==========
771newcloud (rep)
772Registers the on-prem replicator into a cloud site (i.e. a site with vcd and
773 c4 configured).
774 Usage: h4cli newcloud api_url api_thumbprint require_onprem_auth org_user org_password site description local_user local_password
775
776==========
777newmgr (rep)
778Registers the replicator to the given manager. The newrep must be invoked on the manager prior to this.
779 The same request can be used to notify the manager that the replicator has a new certificate.
780 Usage: h4cli newmgr mgr_api_url mgr_thumbprint pairing_cookie local_vc_user local_vc_pass
781
782==========
783removemanager (rep)
784Removes the given manager only if there are no active replications,
785 associated with it.
786
787 Usage: h4cli removemanager managerId
788
789==========
790replicatorhealthinfo (rep)
791Asks the replicator for healthcheck info.
792
793==========
794rtr_check_updates (rep)
795Retrieves the available update versions from the configured repository.
796 Usage: h4cli rtr_check_updates
797
798==========
799rtr_get_local_certificate (rep)
800Retrieves local certificate.
801 Usage: h4cli rtr_get_local_certificate
802
803==========
804rtr_get_update_eula (rep)
805Retrieves the available update EULA.
806 Usage: h4cli rtr_get_update_eula
807
808==========
809rtr_get_update_repo (rep)
810Retrieves the currently configured update repository URL.
811 Usage: h4cli rtr_get_update_repo
812
813==========
814rtr_passwd_expired (rep)
815Determines if the root password has expired and therefore requires a reset.
816 Usage: h4cli rtr_passwd_expired
817
818==========
819rtr_reboot_os (rep)
820TODO: write me!
821
822==========
823rtr_reboot_services (rep)
824TODO: write me!
825
826==========
827rtr_regenerate_local_certificate (rep)
828Generates new local certificate.
829 Usage: h4cli rtr_regenerate_local_certificate
830
831==========
832rtr_set_custom_update_repo (rep)
833Changes the custom update repository URL. This can be an update repo hosted
834 in the client's infrastructure or an iso attached to the VM as cd-rom. In the
835 latter case 'cdrom://' should be used. Username and password are optional and
836 are only for the former case.
837
838 If set the custom repo will always be preferred to the default repo. To use
839 the default repo the custom one should be set to an empty string ''.
840
841 Usage: h4cli rtr_set_custom_update_repo new_update_repo [username] [password]
842
843==========
844rtr_update (rep)
845Updates to the latest available version.
846 Usage: h4cli rtrupdate
847
848==========
849rtr_upload_certificate (rep)
850Replaces the server certificate with the user-provided one.
851 Expected container format is PKCS#12. It must conatin one private key and
852 its associated certificate.
853
854 Usage: h4cli rtr_upload_certificate file_path [password]
855 Where file_path is the path to the p12/pfx file
856 password is the PKCS#12 container password; can be omitted if it's empty string
857
858==========
859rtrbundles (rep)
860Lists all support bundles currently available for download from the replicator.
861 They are sorted by date of creation in descending order - newly created
862 bundles are first.
863
864==========
865rtrchangepw (rep)
866Changes the replicator's appliance password.
867 Usage: h4cli rtrchangepw current_password new_password
868
869==========
870rtrcheckcloud (rep)
871Checks cloud credentials against C4 service at given url
872
873==========
874rtrchecksso (rep)
875Checks sso credentials against STS from the passed ls_url
876
877==========
878rtrcloudreverse (rep)
879Reverses the given C4 replication.
880 Usage: h4cli rtrcloudreverse cloud_id cloud_auth replication_id
881 Where:
882 cloud_id is the unique cloud id
883 cloud_auth is a c4 session authentication token which will be used
884 when talking to the c4 instance
885 replication_id is the c4 replication id
886
887==========
888rtrcloudstart (rep)
889Starts a new replication. Useful for v2c and c2v.
890 Usage: h4cli rtrcloudstart cloud_auth source destination [rpo] [flags] [retention_policy] [initial_sync_time] [is_migration]
891 Where:
892 cloud_auth is a c4 session authentication token which will be used
893 when talking to the c4 instance
894 source - vm:siteId:vmId or vapp:siteId:vappId or vcVm:siteId:vcUuid:vm-mo-id
895 destination - vcloud:siteId:vdcId[:storagePolicy] or vm:siteId:vdcId::seedVmId or vc:siteId[:seedVm]
896 rpo - defaults to '5' minutes
897 flags - defaults to csq, where 'c' means compressed, 's' means encrypted, 'q' means quiesced
898 retention_policy - allows you to configure MPIT instances. Format: 'noInstances1,distance1,noInstance2,distance2,...'
899 initial_sync_time - optionally delay the initial sync
900 is_migration - optionally mark the replication as migration
901
902==========
903rtrcloudvms (rep)
904Retrieves on-prem vms. Useful for v2c.
905 Usage: h4cli rtrcloudvms cloud_id vc_id cloud_auth
906 Where:
907 cloud_id is the cloud site id
908 vc_id is the vCenter instance id that manages the source vms
909 cloud_auth is a c4 session authentication token which will be used
910 when talking to the c4 instance
911
912==========
913rtrcomputeresources (rep)
914Discovers compute resources in the vCenter inventory.
915
916 Usage: h4cli rtrcomputeresources manager-id vc-id [entity-mo-id]
917 Where manager-id is the id of a known paired manager. The credentials associated with this manager will be used to query the VCs.
918 vc-id is the instance UUID of a vCenter Server in the local PSC.
919 entity-mo-id is a Folder/Datacenter/ComputeResource/ResourcePool Managed Object ID in the inventory of vc-id. If omitted, the inventory root folder will be used.
920
921==========
922rtrconfig (rep)
923Gets the config for the Replicator.
924 Usage: h4cli rtrconfig
925
926==========
927rtrdatastores (rep)
928Discovers datastores accessible from the given resource pool.
929
930 Usage: h4cli rtrdatastores manager-id vc-id [resource-pool-mo-id]
931 Where manager-id is the id of a known paired manager. The credentials associated with this manager will be used to query the VCs.
932 vc-id is the instance UUID of a vCenter Server in the local PSC.
933 resource-pool-mo-id is a ResourcePool Managed Object ID in the inventory of vc-id, e.g. 'resgroup-49'
934
935==========
936rtrdeletebundle (rep)
937Delete a support bundle in the replicator.
938
939==========
940rtrdeletereplicationplacement (rep)
941Unconfigures the default replication placement for the given manager.
942
943 Usage: h4cli rtrdeletereplicationplacement manager_id
944
945==========
946rtrdownloadbundle (rep)
947Downloads the specified support bundle.
948 Usage: h4cli downloadbundle bundle-id
949
950 Note: this command spawns an external curl process and is quite insecure!
951
952==========
953rtrendpoints (rep)
954Retrieves the current endpoint configuration of the replicator. If any
955 of the addresses are empty, this means that they're are detected automatically.
956 Usage: h4cli rtrgetendpoints
957
958==========
959rtrfailover (rep)
960Calls 'replications/replication_id/failover' in the destination replicator.
961 Use in emergencies only (when the manager is permanently unavailable).
962 Usage: h4cli rtrfailover replication_id [power_on] [placement_settings] [instance_id] [expose_snapshots] [consolidate_disks] [custom_hardware]
963 where:
964 power_on (defaults to true) indicates whether the recovered VM should be powered on
965 placement_settings (by default retrieved by MTA) indicates where to locate the recovered VM. Format 'vm_folder,res_pool_id,host_id', all elements are required. Example: vmfolder-group-v3,resgroup-8,host-9
966 instance_id (by default latest instance is used) indicates which instance to use for recovery point
967 expose_snapshots (defaults to true) indicates whether the previous PIT's should be exposed as snapshots of the recovered VM
968 consolidate_disks (defaults to false) indicates whether the disks of all available instances should be consolidated into a single disk
969 custom_hardware (by default recovered vm has the exact same hardware as the original) allows the number of cpus,cores_per_socket,memory_in_mib,mac_address_policy for the recovered VM to be overriden. Valid values for mac_address_policy are 'GENERATE_NEW' and 'DEFAULT'.
970
971==========
972rtrgeneratebundle (rep)
973Causes a new replicator support bundle to be generated. To download the bundle,
974 use downloadbundle.
975
976==========
977rtrgetcertificate (rep)
978Retrieves the X509/SSL certificate for the given url.
979 Note: The API is accessible only after SSO authentication. Use "h4cli rtrlogin" first!
980 Usage: h4cli rtrgetcertificate url
981
982==========
983rtrgetreplicationplacement (rep)
984Gets the replication placement for the given manager.
985 It'll be used if the user tries to configure a replication without providing
986 placement.
987
988 Usage: h4cli rtrgetreplicationplacement manager_id
989
990==========
991rtrgettelemetrysetup (rep)
992Queries current telemetry setup.
993
994==========
995rtrlogin (rep)
996Creates a replicator session using the credentials stored in the config file
997 (or overridden on the command line).
998 Usage: h4cli [-u username] [-p password] rtrlogin
999
1000==========
1001rtrloginroot (rep)
1002Creates a replicator session using the supplied appliance root password
1003 Usage: h4cli rtrloginroot 'root password'
1004
1005==========
1006rtrloglevel (rep)
1007Updates the log level setting for a specific logback logger at runtime
1008 without requiring a service restart. Note that changes are not persisted
1009 across reboots.
1010
1011 Usage h4cli rtrloglevel com.parent.child.logger [ALL|TRACE|DEBUG|INFO|WARN|ERROR|OFF]
1012 Where:
1013 logger - logback logger name
1014 level - the new log level for the given logger; if no level is given then
1015 the log level setting for the logger will be removed.
1016
1017==========
1018rtrloglevels (rep)
1019Retrieves all logback log levels currently in effect for the service.
1020
1021 Usage h4cli rtrloglevels
1022
1023==========
1024rtrlogout (rep)
1025Destroys the current replicator session.
1026
1027==========
1028rtrnetwork (rep)
1029Obtains the appliance network configuration.
1030 Usage: h4cli rtrnetwork
1031
1032==========
1033rtrnetworks (rep)
1034Discovers networks applicable to the given resource pool.
1035
1036 Usage: h4cli rtrnetworks manager-id vc-id resource-pool-mo-id
1037 Where manager-id is the id of a known paired manager. The credentials associated with this manager will be used to query the VCs.
1038 vc-id is the instance UUID of a vCenter Server in the local PSC.
1039 resource-pool-mo-id is a ResourcePool Managed Object ID in the inventory of vc-id, e.g. 'resgroup-49'
1040
1041==========
1042rtrping (rep)
1043Checks if the replicator's API endpoint is operational.
1044
1045==========
1046rtrregtunnel (rep)
1047Enables integration with the tunneling service.
1048
1049 Usage: h4cli rtrregtunnel tunnel_address [tunnel_port=8048]
1050
1051==========
1052rtrsession (rep)
1053Retrieves the current session details.
1054 Usage: h4cli rtrsession
1055
1056==========
1057rtrsetconfig (rep)
1058Performs initial config for a Replicator.
1059 Usage: h4cli rtrsetconfig config_secret root_password ls_url ls_thumbprint
1060
1061==========
1062rtrsetdns (rep)
1063Obtains the appliance network configuration.
1064 Usage: h4cli rtrsetdns ip-addr-1 [ip-addr2] [domain-name] [searchDomain1,...,searchDomainN]
1065
1066==========
1067rtrsetendpoints (rep)
1068Configures the replicator's endpoint configuration. An empty string means that
1069 the given address is detected automatically. If any of the option is not given,
1070 it'll be auto detected.
1071
1072 management_address - the IP address or hostname for HTTPS (management) traffic.
1073 lwd_address - The address replication sources (lwdproxies or ESXi HBR filters)
1074 should use when sending LWD to the replicator
1075 It has to be a literal IPv4 or IPv6 address due to a ESXi limitation.
1076 nfc_address - The local appliance address the replicator should use when making outgoing NFC
1077 connections to the destination NFC host. Must be a literal IPv4 or IPv6 address.
1078
1079 Usage: h4cli rtrsetendpoints management_address lwd_address nfc_address
1080
1081==========
1082rtrsethostname (rep)
1083Updates the virtual appliance hostname.
1084 Usage: h4cli rtrsethostname 'host.domain'
1085
1086==========
1087rtrsetls (rep)
1088Changes the lookup service of the replicator. Requires admin session
1089 Usage: h4cli rtrsetls url thumbprint
1090
1091==========
1092rtrsetnic (rep)
1093Reconfigures the respective Network Interface Card.
1094
1095 Usage: h4cli rtrsetnic eth0 [mode] [ipv4-addr] [ipv4-netmask] [ipv4_gateway] [ipv6-addr] [ipv6-prefix] [ipv6-gateway]
1096 Where:
1097 eth0 is the name of the NIC in the appliance
1098 mode is one of DHCPV4, DHCPV6, AUTOV6, DHCPV4+DHCPV6, DHCPV4+AUTOV6,
1099 STATICV4, STATICV4+DHCPV6, STATICV4+AUTOV6, STATICV6,
1100 DHCPV4+STATICV6, STATICV4+STATICV6.
1101 ipv4-addr is a literal IPv4 addres (only used if mode is STATICV4*)
1102 ipv4-netmask is IPv4 netmask like 255.255.255.0 (only used if mode is STATICV4*)
1103 ipv4-gateway is an optional literal IPv4 address of a gateway (only used if mode is STATICV4*)
1104 ipv6-addr is a literal IPv6 address (only used if mode is *STATICV6)
1105 ipv6-prefix is a the IPv6 network prefix (only used if mode is *STATICV6)
1106 ipv6-gateway is 'default' or an optional literal IPv6 address (only used if mode is *STATICV6)
1107
1108==========
1109rtrsetreplicationplacement (rep)
1110Sets the replication placement for the given manager.
1111 It'll be used if the user tries to configure/recover a replication without
1112 providing placement.
1113
1114 Usage: h4cli rtrgetreplicationplacement manager_id vc_id datastore_id datastore_folder resource_pool [vm_folder] [host] [network_id]
1115
1116==========
1117rtrtask (rep)
1118Retrieves the details (from the replicator) for the task with the given uuid.
1119 Usage: h4cli rtrtask task-id
1120
1121==========
1122rtrtasks (rep)
1123Retrieves a list of tasks, visible to the current user.
1124 Usage: h4cli rtrtasks [ids] [user] [state] [start_time_before] [start_time_after] [end_time_before] [end_time_after] [type] [resource_id] [resource_type] [sort] [limit] [offset]
1125 Where:
1126 ids filters tasks by task uuids (comma separated)
1127 user is the user, started the task; filtering is available only to admins
1128 state filters tasks by state (one of RUNNING, SUCCEEDED, FAILED)
1129 start_time_before filter tasks where the start time is less than the given value
1130 start_time_after filter tasks where the start time is greater than the given value
1131 end_time_before filter tasks where the end time is less than the given value
1132 end_time_after filter tasks where the end time is greater than the given value
1133 type filter tasks by task.worfklowInfo.type
1134 resource_id filter tasks by task.worfklowInfo.resourceId
1135 resource_type filter tasks by task.worfklowInfo.resourceId
1136 sort list of comma-separated field names;
1137 fields, ending in "-" indicates desc order;
1138 supported sorting fields - "user", "state", "startTime", "endTime"
1139 limit maximum number of tasks to retrieve
1140 offset number of items to skip
1141
1142==========
1143rtrtelemetrysetup (rep)
1144Ammends telemetry setup.
1145
1146==========
1147rtrunregtunnel (rep)
1148Disables integration with the tunneling service.
1149
1150 Usage: h4cli rtrunregtunnel
1151
1152==========
1153rtrunsetls (rep)
1154Removes the lookup service configuration of the replicator
1155
1156 Usage: h4cli rtrunsetls
1157
1158==========
1159rtrvcs (rep)
1160Returns information about the vCenter Servers in the local PSC.
1161
1162 Usage: h4cli rtrvcs manager-id
1163 Where manager-id is the id of a known paired manager. The credentials associated with this manager will be used to query the VCs.
1164
1165==========
1166rtrvmfolders (rep)
1167Returns information about a vCenter inventory VM folder and its children.
1168
1169 Usage: h4cli rtrvmfolders manager-id vc-id [folder-mo-id]
1170 Where manager-id is the id of a known paired manager. The credentials associated with this manager will be used to query the VCs.
1171 vc-id is the instance UUID of a vCenter Server in the local PSC.
1172 folder-mo-id is a Datacenter or VM folder in the inventory of vc-id. If omitted, the inventory root folder will be used.
1173
1174==========
1175rtrwait (rep)
1176Similar to the 'rtrtask' command, however, if the respective task has not yet
1177 completed, it will be polled until it completes.
1178 Usage: h4cli rtrwait task-uuid
1179
1180==========
1181rtrwaitboot (rep)
1182Waits until the replicator boots or a timeout occurs.
1183
1184==========
1185sourcereplications (rep)
1186Retrieves all source replications.
1187 Usage: h4cli sourcereplications
1188
1189==========
1190stopsrc (rep)
1191Stops a source replication via the replicator API.
1192 Use in emergencies only (when the manager is permanently unavailable).
1193 Usage h4cli stop group_id
1194
1195==========
1196updatecloud (rep)
1197Updates a registration of the on-prem replicator in a cloud site
1198 Usage: h4cli updatecloud cloud_id api_url api_thumbprint require_onprem_auth org_user org_password description local_user local_password
1199
1200==========
1201updatemanagerdetails (rep)
1202Tells the replicator to the update the details of a manager. All values are
1203 required. In case some of them haven't changed, provide the old ones!
1204
1205 Usage: h4cli updatemanagerdetails manager_id api_url new_thumbprint localUser localPassword
1206
1207==========
1208tunbundles (tun)
1209Lists all support bundles of the tunnel.
1210
1211 Usage: h4cli tunbundles
1212
1213==========
1214tunconfig (tun)
1215Gets the config for the Tunneling Service.
1216 Usage: h4cli rtrconfig
1217
1218==========
1219tundeletebundle (tun)
1220Delete a support bundle in the tunnel.
1221
1222 Usage: h4cli tundeletebundle 'bundle_id'
1223
1224==========
1225tundownloadbundle (tun)
1226Downloads the specified support bundle.
1227
1228 Usage: h4cli tundownloadbundle 'bundle-id'
1229
1230 Note: this command spawns an external curl process and is quite insecure!
1231
1232==========
1233tundownloadbundlewithcookie (tun)
1234Downloads the specified support bundle.
1235
1236 Usage: h4cli tundownloadbundle 'bundle-id'
1237
1238 Note: this command spawns an external curl process and is quite insecure!
1239
1240==========
1241tunendpoints (tun)
1242Retrieves the current endpoint configuration of the tunnel service. If any
1243 of the addresses are empty, this means that they're are detected automatically.
1244 Usage: h4cli tunendpoints
1245
1246==========
1247tungeneratebundle (tun)
1248Causes a new tunnel support bundle to be generated. To download the bundle,
1249 use tundownloadbundle.
1250
1251 Usage: h4cli tungeneratebundle
1252
1253==========
1254tungeneratebundlewithid (tun)
1255Causes a new tunnel support bundle to be generated with the given ID. To download the bundle,
1256 use tundownloadbundle.
1257
1258 Usage: h4cli tungeneratebundlewithid 'bundle_id'
1259
1260==========
1261tungeneratedownloadbundlecookie (tun)
1262Creates a cookie which can be used to download the bundle with the given ID without authentication.
1263
1264 Usage: h4cli tungeneratedownloadbundlecookie 'bundle_id'
1265
1266==========
1267tungetcertificate (tun)
1268Retrieves the X509/SSL certificate for the given url.
1269 Note: The API is accessible only after SSO authentication. Use "h4cli tunlogin" first!
1270 Usage: h4cli tungetcertificate url
1271
1272==========
1273tunhealthinfo (tun)
1274Asks the tunnel for healthcheck info.
1275
1276==========
1277tunlogin (tun)
1278Creates a tunnel service session using the credentials stored in the config
1279 file (or overridden on the command line).
1280 Usage: h4cli [-u username] [-p password] [-t tun-addr] tunlogin
1281
1282==========
1283tunloginroot (tun)
1284Creates a tunnel service session using the supplied appliance root password
1285 Usage: h4cli tunloginroot 'root password'
1286
1287==========
1288tunloglevel (tun)
1289Updates the log level setting for a specific logback logger at runtime
1290 without requiring a service restart. Note that changes are not persisted
1291 across reboots.
1292
1293 Usage h4cli tunloglevel com.parent.child.logger [ALL|TRACE|DEBUG|INFO|WARN|ERROR|OFF]
1294 Where:
1295 logger - logback logger name
1296 level - the new log level for the given logger; if no level is given then
1297 the log level setting for the logger will be removed.
1298
1299==========
1300tunloglevels (tun)
1301Retrieves all logback log levels currently in effect for the service.
1302
1303 Usage h4cli tunloglevels
1304
1305==========
1306tunlogout (tun)
1307Destroys the current session.
1308
1309==========
1310tunsession (tun)
1311Retrieves the current session details.
1312 Usage: h4cli tunsession
1313
1314==========
1315tunsetconfig (tun)
1316Performs initial config for a tunneling service.
1317 Usage: h4cli tunsetconfig config_secret root_password ls_url ls_thumbprint
1318
1319==========
1320tunsetendpoints (tun)
1321Updates the tunnel service's endpoint configuration. An empty string means
1322 that the given address is detected automatically. If any of the option is
1323 not given, it'll be auto detected.
1324
1325 mgmt_address - the IP address or hostname for HTTPS (management) traffic to advertise to components on the local site.
1326 mgmt_port - the port number for HTTPS (management) traffic to advertise to components on the local site.
1327 mgmt_public_address - the IP address or hostname for HTTPS (management) traffic to advertise to components on remote sites.
1328 mgmt_public_port - the port number for HTTPS (management) traffic to advertise to components on remote sites.
1329 tunnel_address - the IP address or hostname for HTTPS (management) traffic to advertise to components on the local site.
1330 tunnel_port - the port number for HTTPS (management) traffic to advertise to components on the local site.
1331 tunnel_public_address - the IP address or hostname for HTTPS (management) traffic to advertise to components on remote sites.
1332 tunnel_public_port - the port number for HTTPS (management) traffic to advertise to components on remote sites.
1333
1334 Usage: h4cli tunsetendpoints mgmt_address mgmt_port mgmt_public_address mgmt_public_port tunnel_address tunnel_port tunnel_public_address tunnel_public_port
1335
1336==========
1337tunsetls (tun)
1338Changes the lookup service of the tunnel. Requires admin session
1339 Usage: h4cli tunsetls url thumbprint
1340 To configure the tunnel to stop using a lookup service: h4cli tunsetls ''
1341
1342==========
1343tuntask (tun)
1344Retrieves the details (from the tunnel) for the task with the given uuid.
1345 Usage: h4cli tuntask task-id
1346
1347==========
1348tununsetls (tun)
1349Removes the lookup service configuration of the tunnel
1350 Usage: h4cli tununsetls
1351
1352==========
1353tunupload_certificate (tun)
1354Replaces the server certificate with the user-provided one.
1355 Expected container format is PKCS#12. It must conatin one private key and
1356 its associated certificate.
1357
1358 Usage: h4cli tunupload_certificate file_path [password]
1359 Where file_path is the path to the p12/pfx file
1360 password is the PKCS#12 container password; can be omitted if it's empty string
1361
1362==========
1363tunwait (tun)
1364Similar to the 'tuntask' command, however, if the respective task has not yet
1365 completed, it will be polled until it completes.
1366 Usage: h4cli tunwait task-uuid