admin functions (forest)

For information on how to import the functions in this module, refer to the main admin library page.

33 functions

Function name	Description
admin:forest-add-backup	This function adds scheduled backup specifications for a forest to a configuration.
admin:forest-add-failover-host	This function adds a failover host to the list of failover hosts for the specified forest in the specified configuration.
admin:forest-add-replica	This function adds a forest replica to a master forest.
admin:forest-copy	This function creates a new forest specification with the same settings as the forest with the specified ID.
admin:forest-create	This function creates a new forest configuration.
admin:forest-delete	This function deletes the configuration for the specified forest from the configuration.
admin:forest-delete-backup	This function deletes scheduled backup specifications for a forest from a configuration.
admin:forest-delete-failover-host	This function deletes the specified failover host(s) from the failover-host list in the specified configuration.
admin:forest-exists	This function determines whether or not the specified forest exists.
admin:forest-get-backups	This function returns the scheduled backups for the specified forest from the configuration.
admin:forest-get-data-directory	This function returns the name of the data directory of the specified forest.
admin:forest-get-database	This function returns the ID of the database that uses the specified forest.
admin:forest-get-enabled	This function returns the enabled state of the specified forest.
admin:forest-get-failover-enable	This function returns the state of whether failover is enabled for the specified forest.
admin:forest-get-failover-hosts	This function returns the IDs of the hosts defined as failover hosts for this forest.
admin:forest-get-fast-data-directory	This function returns the directory path set in the fast data directory field for the specified forest.
admin:forest-get-host	This function returns the ID of the host in which the specified forest resides.
admin:forest-get-id	This function returns the ID of the forest with the specified name, from the specified configuration.
admin:forest-get-large-data-directory	This function returns the name of the large data directory of the specified forest.
admin:forest-get-name	This function returns the name of the specified forest, given the forest ID.
admin:forest-get-replicas	This function returns the IDs of the forest replicas for the specified forest.
admin:forest-get-updates-allowed	This function returns the state of what kinds of updates are allowed for the specified forest.
admin:forest-hourly-backup	This function constructs a hourly scheduled forest backup.
admin:forest-minutely-backup	This function constructs a scheduled forest backup on a number-of-minutes basis.
admin:forest-monthly-backup	This function constructs a monthly scheduled backup.
admin:forest-one-time-backup	This function constructs a one-time backup.
admin:forest-remove-replica	This function removes a forest replica from a master forest.
admin:forest-set-enabled	This function sets the enabled state for a forest configuration.
admin:forest-set-failover-enable	This function sets the forest failover enabled state for a forest configuration.
admin:forest-set-host	This function sets a forest configuration to a new host.
admin:forest-set-updates-allowed	This function sets the updates-allowed state for a forest configuration.
admin:forest-weekly-backup	This function constructs a weekly scheduled backup.
admin:get-forest-ids	This function returns all the forest IDs from the configuration.