diff --git a/docs/manuals/en/new_main_reference/Makefile b/docs/manuals/en/new_main_reference/Makefile index 9dac94f3dd3..9ab396a4f1a 100644 --- a/docs/manuals/en/new_main_reference/Makefile +++ b/docs/manuals/en/new_main_reference/Makefile @@ -19,7 +19,7 @@ BUILDDIR = BareosMainReference #nothing: # Put it first so that "make" without argument is like "make help". -all: $(GENERATED) pre latexpand split pandoc post1 post2 presphinx sphinx +all: $(GENERATED) copy pre latexpand split pandoc post1 post2 presphinx sphinx autogenerated/bareos-dir-*.rst.inc: autogenerated/bareos-dir-config-schema.json # generates all director-resource files @@ -43,6 +43,16 @@ autogenerated/bareos-tray-monitor-*.rst.inc: autogenerated/bareos-tray-monitor-c autogenerated: $(GENERATED) +copy: + # IN: ../main/**.tex + # OUT: source/** + mkdir -p source/include/config/ + cp -a ../main/*.txt source/include/ + cp -a ../main/config/*.conf source/include/config/ + mkdir -p source/autogenerated/ + cp -a ../main/autogenerated/*-resource-*-description.rst.inc source/autogenerated/ + + pre: # IN: ../main/**.tex # OUT: build/pre/**.tex diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-catalog-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-catalog-description.rst.inc new file mode 100644 index 00000000000..966564a57bb --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-catalog-description.rst.inc @@ -0,0 +1,203 @@ +.. config:option:: dir/catalog/Address + + :type: STRING + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-catalog-Address.rst.inc + + + +.. config:option:: dir/catalog/DbAddress + + :type: STRING + + .. include:: /config-directive-description/dir-catalog-DbAddress.rst.inc + + + +.. config:option:: dir/catalog/DbDriver + + :required: True + :type: STRING + + .. include:: /config-directive-description/dir-catalog-DbDriver.rst.inc + + + +.. config:option:: dir/catalog/DbName + + :required: True + :type: STRING + + .. include:: /config-directive-description/dir-catalog-DbName.rst.inc + + + +.. config:option:: dir/catalog/DbPassword + + :type: AUTOPASSWORD + + .. include:: /config-directive-description/dir-catalog-DbPassword.rst.inc + + + +.. config:option:: dir/catalog/DbPort + + :type: PINT32 + + .. include:: /config-directive-description/dir-catalog-DbPort.rst.inc + + + +.. config:option:: dir/catalog/DbSocket + + :type: STRING + + .. include:: /config-directive-description/dir-catalog-DbSocket.rst.inc + + + +.. config:option:: dir/catalog/DbUser + + :type: STRING + + .. include:: /config-directive-description/dir-catalog-DbUser.rst.inc + + + +.. config:option:: dir/catalog/Description + + :type: STRING + + .. include:: /config-directive-description/dir-catalog-Description.rst.inc + + + +.. config:option:: dir/catalog/DisableBatchInsert + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-catalog-DisableBatchInsert.rst.inc + + + +.. config:option:: dir/catalog/ExitOnFatal + + :type: BOOLEAN + :default: no + :version: 15.1.0 + + Make any fatal error in the connection to the database exit the program + + .. include:: /config-directive-description/dir-catalog-ExitOnFatal.rst.inc + + + +.. config:option:: dir/catalog/IdleTimeout + + :type: PINT32 + :default: 30 + + This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the idle time after which a database pool should be shrinked. + + .. include:: /config-directive-description/dir-catalog-IdleTimeout.rst.inc + + + +.. config:option:: dir/catalog/IncConnections + + :type: PINT32 + :default: 1 + + This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the number of connections to add to a database pool when not enough connections are available on the pool anymore. + + .. include:: /config-directive-description/dir-catalog-IncConnections.rst.inc + + + +.. config:option:: dir/catalog/MaxConnections + + :type: PINT32 + :default: 5 + + This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the maximum number of connections to a database to keep in this database pool. + + .. include:: /config-directive-description/dir-catalog-MaxConnections.rst.inc + + + +.. config:option:: dir/catalog/MinConnections + + :type: PINT32 + :default: 1 + + This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the minimum number of connections to a database to keep in this database pool. + + .. include:: /config-directive-description/dir-catalog-MinConnections.rst.inc + + + +.. config:option:: dir/catalog/MultipleConnections + + :type: BIT + + .. include:: /config-directive-description/dir-catalog-MultipleConnections.rst.inc + + + +.. config:option:: dir/catalog/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-catalog-Name.rst.inc + + + +.. config:option:: dir/catalog/Password + + :type: AUTOPASSWORD + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-catalog-Password.rst.inc + + + +.. config:option:: dir/catalog/Reconnect + + :type: BOOLEAN + :default: no + :version: 15.1.0 + + Try to reconnect a database connection when its dropped + + .. include:: /config-directive-description/dir-catalog-Reconnect.rst.inc + + + +.. config:option:: dir/catalog/User + + :type: STRING + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-catalog-User.rst.inc + + + +.. config:option:: dir/catalog/ValidateTimeout + + :type: PINT32 + :default: 120 + + This directive is used by the experimental database pooling functionality. Only use this for non production sites. This sets the validation timeout after which the database connection is polled to see if its still alive. + + .. include:: /config-directive-description/dir-catalog-ValidateTimeout.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-client-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-client-description.rst.inc new file mode 100644 index 00000000000..f675ed427f4 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-client-description.rst.inc @@ -0,0 +1,430 @@ +.. config:option:: dir/client/Address + + :required: True + :type: STRING + + .. include:: /config-directive-description/dir-client-Address.rst.inc + + + +.. config:option:: dir/client/AllowClientConnect + + :type: BOOLEAN + :version: deprecated + + Alias of "Connection From Client To Director". + + .. include:: /config-directive-description/dir-client-AllowClientConnect.rst.inc + + + +.. config:option:: dir/client/AuthType + + :type: AUTH_TYPE + :default: None + + .. include:: /config-directive-description/dir-client-AuthType.rst.inc + + + +.. config:option:: dir/client/AutoPrune + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-client-AutoPrune.rst.inc + + + +.. config:option:: dir/client/Catalog + + :type: RES + + .. include:: /config-directive-description/dir-client-Catalog.rst.inc + + + +.. config:option:: dir/client/ConnectionFromClientToDirector + + :type: BOOLEAN + :default: no + :version: 16.2.2 + + The Director will accept incoming network connection from this Client. + + .. include:: /config-directive-description/dir-client-ConnectionFromClientToDirector.rst.inc + + + +.. config:option:: dir/client/ConnectionFromDirectorToClient + + :type: BOOLEAN + :default: yes + :version: 16.2.2 + + Let the Director initiate the network connection to the Client. + + .. include:: /config-directive-description/dir-client-ConnectionFromDirectorToClient.rst.inc + + + +.. config:option:: dir/client/Description + + :type: STRING + + .. include:: /config-directive-description/dir-client-Description.rst.inc + + + +.. config:option:: dir/client/Enabled + + :type: BOOLEAN + :default: yes + + En- or disable this resource. + + .. include:: /config-directive-description/dir-client-Enabled.rst.inc + + + +.. config:option:: dir/client/FdAddress + + :type: STRING + + Alias for Address. + + .. include:: /config-directive-description/dir-client-FdAddress.rst.inc + + + +.. config:option:: dir/client/FdPassword + + :type: AUTOPASSWORD + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-client-FdPassword.rst.inc + + + +.. config:option:: dir/client/FdPort + + :type: PINT32 + :default: 9102 + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-client-FdPort.rst.inc + + + +.. config:option:: dir/client/FileRetention + + :type: TIME + :default: 5184000 + + .. include:: /config-directive-description/dir-client-FileRetention.rst.inc + + + +.. config:option:: dir/client/HardQuota + + :type: SIZE64 + :default: 0 + + .. include:: /config-directive-description/dir-client-HardQuota.rst.inc + + + +.. config:option:: dir/client/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/dir-client-HeartbeatInterval.rst.inc + + + +.. config:option:: dir/client/JobRetention + + :type: TIME + :default: 15552000 + + .. include:: /config-directive-description/dir-client-JobRetention.rst.inc + + + +.. config:option:: dir/client/LanAddress + + :type: STRING + :version: 16.2.6 + + Sets additional address used for connections between Client and Storage Daemon inside separate network. + + .. include:: /config-directive-description/dir-client-LanAddress.rst.inc + + + +.. config:option:: dir/client/MaximumBandwidthPerJob + + :type: SPEED + + .. include:: /config-directive-description/dir-client-MaximumBandwidthPerJob.rst.inc + + + +.. config:option:: dir/client/MaximumConcurrentJobs + + :type: PINT32 + :default: 1 + + .. include:: /config-directive-description/dir-client-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: dir/client/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-client-Name.rst.inc + + + +.. config:option:: dir/client/NdmpBlockSize + + :type: SIZE32 + :default: 64512 + + .. include:: /config-directive-description/dir-client-NdmpBlockSize.rst.inc + + + +.. config:option:: dir/client/NdmpLogLevel + + :type: PINT32 + :default: 4 + + .. include:: /config-directive-description/dir-client-NdmpLogLevel.rst.inc + + + +.. config:option:: dir/client/NdmpUseLmdb + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-client-NdmpUseLmdb.rst.inc + + + +.. config:option:: dir/client/Passive + + :type: BOOLEAN + :default: no + :version: 13.2.0 + + If enabled, the Storage Daemon will initiate the network connection to the Client. If disabled, the Client will initiate the network connection to the Storage Daemon. + + .. include:: /config-directive-description/dir-client-Passive.rst.inc + + + +.. config:option:: dir/client/Password + + :required: True + :type: AUTOPASSWORD + + .. include:: /config-directive-description/dir-client-Password.rst.inc + + + +.. config:option:: dir/client/Port + + :type: PINT32 + :default: 9102 + + .. include:: /config-directive-description/dir-client-Port.rst.inc + + + +.. config:option:: dir/client/Protocol + + :type: AUTH_PROTOCOL_TYPE + :default: Native + :version: 13.2.0 + + .. include:: /config-directive-description/dir-client-Protocol.rst.inc + + + +.. config:option:: dir/client/QuotaIncludeFailedJobs + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-client-QuotaIncludeFailedJobs.rst.inc + + + +.. config:option:: dir/client/SoftQuota + + :type: SIZE64 + :default: 0 + + .. include:: /config-directive-description/dir-client-SoftQuota.rst.inc + + + +.. config:option:: dir/client/SoftQuotaGracePeriod + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/dir-client-SoftQuotaGracePeriod.rst.inc + + + +.. config:option:: dir/client/StrictQuotas + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-client-StrictQuotas.rst.inc + + + +.. config:option:: dir/client/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/dir-client-TlsAllowedCn.rst.inc + + + +.. config:option:: dir/client/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/dir-client-TlsAuthenticate.rst.inc + + + +.. config:option:: dir/client/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/dir-client-TlsCaCertificateDir.rst.inc + + + +.. config:option:: dir/client/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/dir-client-TlsCaCertificateFile.rst.inc + + + +.. config:option:: dir/client/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/dir-client-TlsCertificate.rst.inc + + + +.. config:option:: dir/client/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/dir-client-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: dir/client/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/dir-client-TlsCipherList.rst.inc + + + +.. config:option:: dir/client/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/dir-client-TlsDhFile.rst.inc + + + +.. config:option:: dir/client/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/dir-client-TlsEnable.rst.inc + + + +.. config:option:: dir/client/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/dir-client-TlsKey.rst.inc + + + +.. config:option:: dir/client/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/dir-client-TlsRequire.rst.inc + + + +.. config:option:: dir/client/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/dir-client-TlsVerifyPeer.rst.inc + + + +.. config:option:: dir/client/Username + + :type: STRING + + .. include:: /config-directive-description/dir-client-Username.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-console-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-console-description.rst.inc new file mode 100644 index 00000000000..ab0f89c704c --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-console-description.rst.inc @@ -0,0 +1,259 @@ +.. config:option:: dir/console/CatalogACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-CatalogACL.rst.inc + + + +.. config:option:: dir/console/ClientACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-ClientACL.rst.inc + + + +.. config:option:: dir/console/CommandACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-CommandACL.rst.inc + + + +.. config:option:: dir/console/Description + + :type: STRING + + .. include:: /config-directive-description/dir-console-Description.rst.inc + + + +.. config:option:: dir/console/FileSetACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-FileSetACL.rst.inc + + + +.. config:option:: dir/console/JobACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-JobACL.rst.inc + + + +.. config:option:: dir/console/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/dir-console-Name.rst.inc + + + +.. config:option:: dir/console/Password + + :required: True + :type: AUTOPASSWORD + + .. include:: /config-directive-description/dir-console-Password.rst.inc + + + +.. config:option:: dir/console/PluginOptionsACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-PluginOptionsACL.rst.inc + + + +.. config:option:: dir/console/PoolACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-PoolACL.rst.inc + + + +.. config:option:: dir/console/Profile + + :type: RESOURCE_LIST + :version: 14.2.3 + + Profiles can be assigned to a Console. ACL are checked until either a deny ACL is found or an allow ACL. First the console ACL is checked then any profile the console is linked to. + + .. include:: /config-directive-description/dir-console-Profile.rst.inc + + + +.. config:option:: dir/console/RunACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-RunACL.rst.inc + + + +.. config:option:: dir/console/ScheduleACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-ScheduleACL.rst.inc + + + +.. config:option:: dir/console/StorageACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-StorageACL.rst.inc + + + +.. config:option:: dir/console/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/dir-console-TlsAllowedCn.rst.inc + + + +.. config:option:: dir/console/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/dir-console-TlsAuthenticate.rst.inc + + + +.. config:option:: dir/console/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/dir-console-TlsCaCertificateDir.rst.inc + + + +.. config:option:: dir/console/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/dir-console-TlsCaCertificateFile.rst.inc + + + +.. config:option:: dir/console/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/dir-console-TlsCertificate.rst.inc + + + +.. config:option:: dir/console/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/dir-console-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: dir/console/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/dir-console-TlsCipherList.rst.inc + + + +.. config:option:: dir/console/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/dir-console-TlsDhFile.rst.inc + + + +.. config:option:: dir/console/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/dir-console-TlsEnable.rst.inc + + + +.. config:option:: dir/console/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/dir-console-TlsKey.rst.inc + + + +.. config:option:: dir/console/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/dir-console-TlsRequire.rst.inc + + + +.. config:option:: dir/console/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/dir-console-TlsVerifyPeer.rst.inc + + + +.. config:option:: dir/console/UsePamAuthentication + + :type: BOOLEAN + :default: no + :version: 18.2.4 + + .. include:: /config-directive-description/dir-console-UsePamAuthentication.rst.inc + + + +.. config:option:: dir/console/WhereACL + + :type: ACL + + .. include:: /config-directive-description/dir-console-WhereACL.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-counter-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-counter-description.rst.inc new file mode 100644 index 00000000000..4ed20cc7979 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-counter-description.rst.inc @@ -0,0 +1,53 @@ +.. config:option:: dir/counter/Catalog + + :type: RES + + .. include:: /config-directive-description/dir-counter-Catalog.rst.inc + + + +.. config:option:: dir/counter/Description + + :type: STRING + + .. include:: /config-directive-description/dir-counter-Description.rst.inc + + + +.. config:option:: dir/counter/Maximum + + :type: PINT32 + :default: 2147483647 + + .. include:: /config-directive-description/dir-counter-Maximum.rst.inc + + + +.. config:option:: dir/counter/Minimum + + :type: INT32 + :default: 0 + + .. include:: /config-directive-description/dir-counter-Minimum.rst.inc + + + +.. config:option:: dir/counter/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-counter-Name.rst.inc + + + +.. config:option:: dir/counter/WrapCounter + + :type: RES + + .. include:: /config-directive-description/dir-counter-WrapCounter.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-device-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-device-description.rst.inc new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-director-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-director-description.rst.inc new file mode 100644 index 00000000000..41f04c149c7 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-director-description.rst.inc @@ -0,0 +1,469 @@ +.. config:option:: dir/director/AbsoluteJobTimeout + + :type: PINT32 + :version: 14.2.0 + + .. include:: /config-directive-description/dir-director-AbsoluteJobTimeout.rst.inc + + + +.. config:option:: dir/director/AuditEvents + + :type: AUDIT_COMMAND_LIST + :version: 14.2.0 + + .. include:: /config-directive-description/dir-director-AuditEvents.rst.inc + + + +.. config:option:: dir/director/Auditing + + :type: BOOLEAN + :default: no + :version: 14.2.0 + + .. include:: /config-directive-description/dir-director-Auditing.rst.inc + + + +.. config:option:: dir/director/BackendDirectory + + :type: DIRECTORY_LIST + :default: /usr/local/lib64/bareos/backends *(platform specific)* + + .. include:: /config-directive-description/dir-director-BackendDirectory.rst.inc + + + +.. config:option:: dir/director/Description + + :type: STRING + + .. include:: /config-directive-description/dir-director-Description.rst.inc + + + +.. config:option:: dir/director/DirAddress + + :type: ADDRESS + :default: 9101 + + .. include:: /config-directive-description/dir-director-DirAddress.rst.inc + + + +.. config:option:: dir/director/DirAddresses + + :type: ADDRESSES + :default: 9101 + + .. include:: /config-directive-description/dir-director-DirAddresses.rst.inc + + + +.. config:option:: dir/director/DirPort + + :type: PORT + :default: 9101 + + .. include:: /config-directive-description/dir-director-DirPort.rst.inc + + + +.. config:option:: dir/director/DirSourceAddress + + :type: ADDRESS + :default: 0 + + .. include:: /config-directive-description/dir-director-DirSourceAddress.rst.inc + + + +.. config:option:: dir/director/FdConnectTimeout + + :type: TIME + :default: 180 + + .. include:: /config-directive-description/dir-director-FdConnectTimeout.rst.inc + + + +.. config:option:: dir/director/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/dir-director-HeartbeatInterval.rst.inc + + + +.. config:option:: dir/director/KeyEncryptionKey + + :type: AUTOPASSWORD + + .. include:: /config-directive-description/dir-director-KeyEncryptionKey.rst.inc + + + +.. config:option:: dir/director/LogTimestampFormat + + :type: STRING + :version: 15.2.3 + + .. include:: /config-directive-description/dir-director-LogTimestampFormat.rst.inc + + + +.. config:option:: dir/director/MaximumConcurrentJobs + + :type: PINT32 + :default: 1 + + .. include:: /config-directive-description/dir-director-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: dir/director/MaximumConnections + + :type: PINT32 + :default: 30 + + .. include:: /config-directive-description/dir-director-MaximumConnections.rst.inc + + + +.. config:option:: dir/director/MaximumConsoleConnections + + :type: PINT32 + :default: 20 + + .. include:: /config-directive-description/dir-director-MaximumConsoleConnections.rst.inc + + + +.. config:option:: dir/director/Messages + + :type: RES + + .. include:: /config-directive-description/dir-director-Messages.rst.inc + + + +.. config:option:: dir/director/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-director-Name.rst.inc + + + +.. config:option:: dir/director/NdmpLogLevel + + :type: PINT32 + :default: 4 + :version: 13.2.0 + + .. include:: /config-directive-description/dir-director-NdmpLogLevel.rst.inc + + + +.. config:option:: dir/director/NdmpSnooping + + :type: BOOLEAN + :version: 13.2.0 + + .. include:: /config-directive-description/dir-director-NdmpSnooping.rst.inc + + + +.. config:option:: dir/director/OmitDefaults + + :type: BOOLEAN + :default: yes + :version: deprecated + + Omit config variables with default values when dumping the config. + + .. include:: /config-directive-description/dir-director-OmitDefaults.rst.inc + + + +.. config:option:: dir/director/OptimizeForSize + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-director-OptimizeForSize.rst.inc + + + +.. config:option:: dir/director/OptimizeForSpeed + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-director-OptimizeForSpeed.rst.inc + + + +.. config:option:: dir/director/Password + + :required: True + :type: AUTOPASSWORD + + .. include:: /config-directive-description/dir-director-Password.rst.inc + + + +.. config:option:: dir/director/PidDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/dir-director-PidDirectory.rst.inc + + + +.. config:option:: dir/director/PluginDirectory + + :type: DIRECTORY + :version: 14.2.0 + + Plugins are loaded from this directory. To load only specific plugins, use 'Plugin Names'. + + .. include:: /config-directive-description/dir-director-PluginDirectory.rst.inc + + + +.. config:option:: dir/director/PluginNames + + :type: PLUGIN_NAMES + :version: 14.2.0 + + List of plugins, that should get loaded from 'Plugin Directory' (only basenames, '-dir.so' is added automatically). If empty, all plugins will get loaded. + + .. include:: /config-directive-description/dir-director-PluginNames.rst.inc + + + +.. config:option:: dir/director/QueryFile + + :required: True + :type: DIRECTORY + + .. include:: /config-directive-description/dir-director-QueryFile.rst.inc + + + +.. config:option:: dir/director/ScriptsDirectory + + :type: DIRECTORY + + This directive is currently unused. + + .. include:: /config-directive-description/dir-director-ScriptsDirectory.rst.inc + + + +.. config:option:: dir/director/SdConnectTimeout + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/dir-director-SdConnectTimeout.rst.inc + + + +.. config:option:: dir/director/SecureEraseCommand + + :type: STRING + :version: 15.2.1 + + Specify command that will be called when bareos unlinks files. + + .. include:: /config-directive-description/dir-director-SecureEraseCommand.rst.inc + + + +.. config:option:: dir/director/StatisticsCollectInterval + + :type: PINT32 + :default: 150 + :version: 14.2.0 + + .. include:: /config-directive-description/dir-director-StatisticsCollectInterval.rst.inc + + + +.. config:option:: dir/director/StatisticsRetention + + :type: TIME + :default: 160704000 + + .. include:: /config-directive-description/dir-director-StatisticsRetention.rst.inc + + + +.. config:option:: dir/director/SubSysDirectory + + :type: DIRECTORY + :version: deprecated + + .. include:: /config-directive-description/dir-director-SubSysDirectory.rst.inc + + + +.. config:option:: dir/director/Subscriptions + + :type: PINT32 + :default: 0 + :version: 12.4.4 + + .. include:: /config-directive-description/dir-director-Subscriptions.rst.inc + + + +.. config:option:: dir/director/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/dir-director-TlsAllowedCn.rst.inc + + + +.. config:option:: dir/director/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/dir-director-TlsAuthenticate.rst.inc + + + +.. config:option:: dir/director/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/dir-director-TlsCaCertificateDir.rst.inc + + + +.. config:option:: dir/director/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/dir-director-TlsCaCertificateFile.rst.inc + + + +.. config:option:: dir/director/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/dir-director-TlsCertificate.rst.inc + + + +.. config:option:: dir/director/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/dir-director-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: dir/director/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/dir-director-TlsCipherList.rst.inc + + + +.. config:option:: dir/director/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/dir-director-TlsDhFile.rst.inc + + + +.. config:option:: dir/director/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/dir-director-TlsEnable.rst.inc + + + +.. config:option:: dir/director/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/dir-director-TlsKey.rst.inc + + + +.. config:option:: dir/director/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/dir-director-TlsRequire.rst.inc + + + +.. config:option:: dir/director/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/dir-director-TlsVerifyPeer.rst.inc + + + +.. config:option:: dir/director/VerId + + :type: STRING + + .. include:: /config-directive-description/dir-director-VerId.rst.inc + + + +.. config:option:: dir/director/WorkingDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/dir-director-WorkingDirectory.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-fileset-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-fileset-description.rst.inc new file mode 100644 index 00000000000..17f7a71fe0a --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-fileset-description.rst.inc @@ -0,0 +1,53 @@ +.. config:option:: dir/fileset/Description + + :type: STRING + + .. include:: /config-directive-description/dir-fileset-Description.rst.inc + + + +.. config:option:: dir/fileset/EnableVSS + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-fileset-EnableVSS.rst.inc + + + +.. config:option:: dir/fileset/Exclude + + :type: INCLUDE_EXCLUDE_ITEM + + .. include:: /config-directive-description/dir-fileset-Exclude.rst.inc + + + +.. config:option:: dir/fileset/IgnoreFileSetChanges + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-fileset-IgnoreFileSetChanges.rst.inc + + + +.. config:option:: dir/fileset/Include + + :type: INCLUDE_EXCLUDE_ITEM + + .. include:: /config-directive-description/dir-fileset-Include.rst.inc + + + +.. config:option:: dir/fileset/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-fileset-Name.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-job-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-job-description.rst.inc new file mode 100644 index 00000000000..5699c0fbf32 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-job-description.rst.inc @@ -0,0 +1,788 @@ +.. config:option:: dir/job/Accurate + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-Accurate.rst.inc + + + +.. config:option:: dir/job/AddPrefix + + :type: STRING + + .. include:: /config-directive-description/dir-job-AddPrefix.rst.inc + + + +.. config:option:: dir/job/AddSuffix + + :type: STRING + + .. include:: /config-directive-description/dir-job-AddSuffix.rst.inc + + + +.. config:option:: dir/job/AllowDuplicateJobs + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-job-AllowDuplicateJobs.rst.inc + + + +.. config:option:: dir/job/AllowHigherDuplicates + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-job-AllowHigherDuplicates.rst.inc + + + +.. config:option:: dir/job/AllowMixedPriority + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-AllowMixedPriority.rst.inc + + + +.. config:option:: dir/job/AlwaysIncremental + + :type: BOOLEAN + :default: no + :version: 16.2.4 + + Enable/disable always incremental backup scheme. + + .. include:: /config-directive-description/dir-job-AlwaysIncremental.rst.inc + + + +.. config:option:: dir/job/AlwaysIncrementalJobRetention + + :type: TIME + :default: 0 + :version: 16.2.4 + + Backup Jobs older than the specified time duration will be merged into a new Virtual backup. + + .. include:: /config-directive-description/dir-job-AlwaysIncrementalJobRetention.rst.inc + + + +.. config:option:: dir/job/AlwaysIncrementalKeepNumber + + :type: PINT32 + :default: 0 + :version: 16.2.4 + + Guarantee that at least the specified number of Backup Jobs will persist, even if they are older than "Always Incremental Job Retention". + + .. include:: /config-directive-description/dir-job-AlwaysIncrementalKeepNumber.rst.inc + + + +.. config:option:: dir/job/AlwaysIncrementalMaxFullAge + + :type: TIME + :version: 16.2.4 + + If "AlwaysIncrementalMaxFullAge" is set, during consolidations only incremental backups will be considered while the Full Backup remains to reduce the amount of data being consolidated. Only if the Full Backup is older than "AlwaysIncrementalMaxFullAge", the Full Backup will be part of the consolidation to avoid the Full Backup becoming too old . + + .. include:: /config-directive-description/dir-job-AlwaysIncrementalMaxFullAge.rst.inc + + + +.. config:option:: dir/job/BackupFormat + + :type: STRING + :default: Native + + .. include:: /config-directive-description/dir-job-BackupFormat.rst.inc + + + +.. config:option:: dir/job/Base + + :type: RESOURCE_LIST + + .. include:: /config-directive-description/dir-job-Base.rst.inc + + + +.. config:option:: dir/job/Bootstrap + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-job-Bootstrap.rst.inc + + + +.. config:option:: dir/job/CancelLowerLevelDuplicates + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-CancelLowerLevelDuplicates.rst.inc + + + +.. config:option:: dir/job/CancelQueuedDuplicates + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-CancelQueuedDuplicates.rst.inc + + + +.. config:option:: dir/job/CancelRunningDuplicates + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-CancelRunningDuplicates.rst.inc + + + +.. config:option:: dir/job/Catalog + + :type: RES + :version: 13.4.0 + + .. include:: /config-directive-description/dir-job-Catalog.rst.inc + + + +.. config:option:: dir/job/Client + + :type: RES + + .. include:: /config-directive-description/dir-job-Client.rst.inc + + + +.. config:option:: dir/job/ClientRunAfterJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-job-ClientRunAfterJob.rst.inc + + + +.. config:option:: dir/job/ClientRunBeforeJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-job-ClientRunBeforeJob.rst.inc + + + +.. config:option:: dir/job/Description + + :type: STRING + + .. include:: /config-directive-description/dir-job-Description.rst.inc + + + +.. config:option:: dir/job/DifferentialBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-job-DifferentialBackupPool.rst.inc + + + +.. config:option:: dir/job/DifferentialMaxRuntime + + :type: TIME + + .. include:: /config-directive-description/dir-job-DifferentialMaxRuntime.rst.inc + + + +.. config:option:: dir/job/DifferentialMaxWaitTime + + :type: TIME + :version: deprecated + + .. include:: /config-directive-description/dir-job-DifferentialMaxWaitTime.rst.inc + + + +.. config:option:: dir/job/DirPluginOptions + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-job-DirPluginOptions.rst.inc + + + +.. config:option:: dir/job/Enabled + + :type: BOOLEAN + :default: yes + + En- or disable this resource. + + .. include:: /config-directive-description/dir-job-Enabled.rst.inc + + + +.. config:option:: dir/job/FdPluginOptions + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-job-FdPluginOptions.rst.inc + + + +.. config:option:: dir/job/FileHistorySize + + :type: SIZE64 + :default: 10000000 + :version: 15.2.4 + + .. include:: /config-directive-description/dir-job-FileHistorySize.rst.inc + + + +.. config:option:: dir/job/FileSet + + :type: RES + + .. include:: /config-directive-description/dir-job-FileSet.rst.inc + + + +.. config:option:: dir/job/FullBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-job-FullBackupPool.rst.inc + + + +.. config:option:: dir/job/FullMaxRuntime + + :type: TIME + + .. include:: /config-directive-description/dir-job-FullMaxRuntime.rst.inc + + + +.. config:option:: dir/job/FullMaxWaitTime + + :type: TIME + :version: deprecated + + .. include:: /config-directive-description/dir-job-FullMaxWaitTime.rst.inc + + + +.. config:option:: dir/job/IncrementalBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-job-IncrementalBackupPool.rst.inc + + + +.. config:option:: dir/job/IncrementalMaxRuntime + + :type: TIME + + .. include:: /config-directive-description/dir-job-IncrementalMaxRuntime.rst.inc + + + +.. config:option:: dir/job/IncrementalMaxWaitTime + + :type: TIME + :version: deprecated + + .. include:: /config-directive-description/dir-job-IncrementalMaxWaitTime.rst.inc + + + +.. config:option:: dir/job/JobDefs + + :type: RES + + .. include:: /config-directive-description/dir-job-JobDefs.rst.inc + + + +.. config:option:: dir/job/JobToVerify + + :type: RES + + .. include:: /config-directive-description/dir-job-JobToVerify.rst.inc + + + +.. config:option:: dir/job/Level + + :type: BACKUP_LEVEL + + .. include:: /config-directive-description/dir-job-Level.rst.inc + + + +.. config:option:: dir/job/MaxConcurrentCopies + + :type: PINT32 + :default: 100 + + .. include:: /config-directive-description/dir-job-MaxConcurrentCopies.rst.inc + + + +.. config:option:: dir/job/MaxDiffInterval + + :type: TIME + + .. include:: /config-directive-description/dir-job-MaxDiffInterval.rst.inc + + + +.. config:option:: dir/job/MaxFullConsolidations + + :type: PINT32 + :default: 0 + :version: 16.2.4 + + If "AlwaysIncrementalMaxFullAge" is configured, do not run more than "MaxFullConsolidations" consolidation jobs that include the Full backup. + + .. include:: /config-directive-description/dir-job-MaxFullConsolidations.rst.inc + + + +.. config:option:: dir/job/MaxFullInterval + + :type: TIME + + .. include:: /config-directive-description/dir-job-MaxFullInterval.rst.inc + + + +.. config:option:: dir/job/MaxRunSchedTime + + :type: TIME + + .. include:: /config-directive-description/dir-job-MaxRunSchedTime.rst.inc + + + +.. config:option:: dir/job/MaxRunTime + + :type: TIME + + .. include:: /config-directive-description/dir-job-MaxRunTime.rst.inc + + + +.. config:option:: dir/job/MaxStartDelay + + :type: TIME + + .. include:: /config-directive-description/dir-job-MaxStartDelay.rst.inc + + + +.. config:option:: dir/job/MaxVirtualFullInterval + + :type: TIME + :version: 14.4.0 + + .. include:: /config-directive-description/dir-job-MaxVirtualFullInterval.rst.inc + + + +.. config:option:: dir/job/MaxWaitTime + + :type: TIME + + .. include:: /config-directive-description/dir-job-MaxWaitTime.rst.inc + + + +.. config:option:: dir/job/MaximumBandwidth + + :type: SPEED + + .. include:: /config-directive-description/dir-job-MaximumBandwidth.rst.inc + + + +.. config:option:: dir/job/MaximumConcurrentJobs + + :type: PINT32 + :default: 1 + + .. include:: /config-directive-description/dir-job-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: dir/job/Messages + + :required: True + :type: RES + + .. include:: /config-directive-description/dir-job-Messages.rst.inc + + + +.. config:option:: dir/job/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-job-Name.rst.inc + + + +.. config:option:: dir/job/NextPool + + :type: RES + + .. include:: /config-directive-description/dir-job-NextPool.rst.inc + + + +.. config:option:: dir/job/PluginOptions + + :type: STRING_LIST + :version: deprecated + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-job-PluginOptions.rst.inc + + + +.. config:option:: dir/job/Pool + + :required: True + :type: RES + + .. include:: /config-directive-description/dir-job-Pool.rst.inc + + + +.. config:option:: dir/job/PreferMountedVolumes + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-job-PreferMountedVolumes.rst.inc + + + +.. config:option:: dir/job/PrefixLinks + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-PrefixLinks.rst.inc + + + +.. config:option:: dir/job/Priority + + :type: PINT32 + :default: 10 + + .. include:: /config-directive-description/dir-job-Priority.rst.inc + + + +.. config:option:: dir/job/Protocol + + :type: PROTOCOL_TYPE + :default: Native + + .. include:: /config-directive-description/dir-job-Protocol.rst.inc + + + +.. config:option:: dir/job/PruneFiles + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-PruneFiles.rst.inc + + + +.. config:option:: dir/job/PruneJobs + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-PruneJobs.rst.inc + + + +.. config:option:: dir/job/PruneVolumes + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-PruneVolumes.rst.inc + + + +.. config:option:: dir/job/PurgeMigrationJob + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-PurgeMigrationJob.rst.inc + + + +.. config:option:: dir/job/RegexWhere + + :type: STRING + + .. include:: /config-directive-description/dir-job-RegexWhere.rst.inc + + + +.. config:option:: dir/job/Replace + + :type: REPLACE_OPTION + :default: Always + + .. include:: /config-directive-description/dir-job-Replace.rst.inc + + + +.. config:option:: dir/job/RerunFailedLevels + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-RerunFailedLevels.rst.inc + + + +.. config:option:: dir/job/RescheduleInterval + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/dir-job-RescheduleInterval.rst.inc + + + +.. config:option:: dir/job/RescheduleOnError + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-RescheduleOnError.rst.inc + + + +.. config:option:: dir/job/RescheduleTimes + + :type: PINT32 + :default: 5 + + .. include:: /config-directive-description/dir-job-RescheduleTimes.rst.inc + + + +.. config:option:: dir/job/Run + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-job-Run.rst.inc + + + +.. config:option:: dir/job/RunAfterFailedJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-job-RunAfterFailedJob.rst.inc + + + +.. config:option:: dir/job/RunAfterJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-job-RunAfterJob.rst.inc + + + +.. config:option:: dir/job/RunBeforeJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-job-RunBeforeJob.rst.inc + + + +.. config:option:: dir/job/RunScript + + :type: RUNSCRIPT + + .. include:: /config-directive-description/dir-job-RunScript.rst.inc + + + +.. config:option:: dir/job/SaveFileHistory + + :type: BOOLEAN + :default: yes + :version: 14.2.0 + + .. include:: /config-directive-description/dir-job-SaveFileHistory.rst.inc + + + +.. config:option:: dir/job/Schedule + + :type: RES + + .. include:: /config-directive-description/dir-job-Schedule.rst.inc + + + +.. config:option:: dir/job/SdPluginOptions + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-job-SdPluginOptions.rst.inc + + + +.. config:option:: dir/job/SelectionPattern + + :type: STRING + + .. include:: /config-directive-description/dir-job-SelectionPattern.rst.inc + + + +.. config:option:: dir/job/SelectionType + + :type: MIGRATION_TYPE + + .. include:: /config-directive-description/dir-job-SelectionType.rst.inc + + + +.. config:option:: dir/job/SpoolAttributes + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-SpoolAttributes.rst.inc + + + +.. config:option:: dir/job/SpoolData + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-job-SpoolData.rst.inc + + + +.. config:option:: dir/job/SpoolSize + + :type: SIZE64 + + .. include:: /config-directive-description/dir-job-SpoolSize.rst.inc + + + +.. config:option:: dir/job/Storage + + :type: RESOURCE_LIST + + .. include:: /config-directive-description/dir-job-Storage.rst.inc + + + +.. config:option:: dir/job/StripPrefix + + :type: STRING + + .. include:: /config-directive-description/dir-job-StripPrefix.rst.inc + + + +.. config:option:: dir/job/Type + + :required: True + :type: JOB_TYPE + + .. include:: /config-directive-description/dir-job-Type.rst.inc + + + +.. config:option:: dir/job/VerifyJob + + :type: RES + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-job-VerifyJob.rst.inc + + + +.. config:option:: dir/job/VirtualFullBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-job-VirtualFullBackupPool.rst.inc + + + +.. config:option:: dir/job/Where + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-job-Where.rst.inc + + + +.. config:option:: dir/job/WriteBootstrap + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-job-WriteBootstrap.rst.inc + + + +.. config:option:: dir/job/WritePartAfterJob + + :type: BOOLEAN + :version: deprecated + + .. include:: /config-directive-description/dir-job-WritePartAfterJob.rst.inc + + + +.. config:option:: dir/job/WriteVerifyList + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-job-WriteVerifyList.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-jobdefs-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-jobdefs-description.rst.inc new file mode 100644 index 00000000000..6c83455a717 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-jobdefs-description.rst.inc @@ -0,0 +1,788 @@ +.. config:option:: dir/jobdefs/Accurate + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-Accurate.rst.inc + + + +.. config:option:: dir/jobdefs/AddPrefix + + :type: STRING + + .. include:: /config-directive-description/dir-jobdefs-AddPrefix.rst.inc + + + +.. config:option:: dir/jobdefs/AddSuffix + + :type: STRING + + .. include:: /config-directive-description/dir-jobdefs-AddSuffix.rst.inc + + + +.. config:option:: dir/jobdefs/AllowDuplicateJobs + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-jobdefs-AllowDuplicateJobs.rst.inc + + + +.. config:option:: dir/jobdefs/AllowHigherDuplicates + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-jobdefs-AllowHigherDuplicates.rst.inc + + + +.. config:option:: dir/jobdefs/AllowMixedPriority + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-AllowMixedPriority.rst.inc + + + +.. config:option:: dir/jobdefs/AlwaysIncremental + + :type: BOOLEAN + :default: no + :version: 16.2.4 + + Enable/disable always incremental backup scheme. + + .. include:: /config-directive-description/dir-jobdefs-AlwaysIncremental.rst.inc + + + +.. config:option:: dir/jobdefs/AlwaysIncrementalJobRetention + + :type: TIME + :default: 0 + :version: 16.2.4 + + Backup Jobs older than the specified time duration will be merged into a new Virtual backup. + + .. include:: /config-directive-description/dir-jobdefs-AlwaysIncrementalJobRetention.rst.inc + + + +.. config:option:: dir/jobdefs/AlwaysIncrementalKeepNumber + + :type: PINT32 + :default: 0 + :version: 16.2.4 + + Guarantee that at least the specified number of Backup Jobs will persist, even if they are older than "Always Incremental Job Retention". + + .. include:: /config-directive-description/dir-jobdefs-AlwaysIncrementalKeepNumber.rst.inc + + + +.. config:option:: dir/jobdefs/AlwaysIncrementalMaxFullAge + + :type: TIME + :version: 16.2.4 + + If "AlwaysIncrementalMaxFullAge" is set, during consolidations only incremental backups will be considered while the Full Backup remains to reduce the amount of data being consolidated. Only if the Full Backup is older than "AlwaysIncrementalMaxFullAge", the Full Backup will be part of the consolidation to avoid the Full Backup becoming too old . + + .. include:: /config-directive-description/dir-jobdefs-AlwaysIncrementalMaxFullAge.rst.inc + + + +.. config:option:: dir/jobdefs/BackupFormat + + :type: STRING + :default: Native + + .. include:: /config-directive-description/dir-jobdefs-BackupFormat.rst.inc + + + +.. config:option:: dir/jobdefs/Base + + :type: RESOURCE_LIST + + .. include:: /config-directive-description/dir-jobdefs-Base.rst.inc + + + +.. config:option:: dir/jobdefs/Bootstrap + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-jobdefs-Bootstrap.rst.inc + + + +.. config:option:: dir/jobdefs/CancelLowerLevelDuplicates + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-CancelLowerLevelDuplicates.rst.inc + + + +.. config:option:: dir/jobdefs/CancelQueuedDuplicates + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-CancelQueuedDuplicates.rst.inc + + + +.. config:option:: dir/jobdefs/CancelRunningDuplicates + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-CancelRunningDuplicates.rst.inc + + + +.. config:option:: dir/jobdefs/Catalog + + :type: RES + :version: 13.4.0 + + .. include:: /config-directive-description/dir-jobdefs-Catalog.rst.inc + + + +.. config:option:: dir/jobdefs/Client + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-Client.rst.inc + + + +.. config:option:: dir/jobdefs/ClientRunAfterJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-jobdefs-ClientRunAfterJob.rst.inc + + + +.. config:option:: dir/jobdefs/ClientRunBeforeJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-jobdefs-ClientRunBeforeJob.rst.inc + + + +.. config:option:: dir/jobdefs/Description + + :type: STRING + + .. include:: /config-directive-description/dir-jobdefs-Description.rst.inc + + + +.. config:option:: dir/jobdefs/DifferentialBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-DifferentialBackupPool.rst.inc + + + +.. config:option:: dir/jobdefs/DifferentialMaxRuntime + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-DifferentialMaxRuntime.rst.inc + + + +.. config:option:: dir/jobdefs/DifferentialMaxWaitTime + + :type: TIME + :version: deprecated + + .. include:: /config-directive-description/dir-jobdefs-DifferentialMaxWaitTime.rst.inc + + + +.. config:option:: dir/jobdefs/DirPluginOptions + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-jobdefs-DirPluginOptions.rst.inc + + + +.. config:option:: dir/jobdefs/Enabled + + :type: BOOLEAN + :default: yes + + En- or disable this resource. + + .. include:: /config-directive-description/dir-jobdefs-Enabled.rst.inc + + + +.. config:option:: dir/jobdefs/FdPluginOptions + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-jobdefs-FdPluginOptions.rst.inc + + + +.. config:option:: dir/jobdefs/FileHistorySize + + :type: SIZE64 + :default: 10000000 + :version: 15.2.4 + + .. include:: /config-directive-description/dir-jobdefs-FileHistorySize.rst.inc + + + +.. config:option:: dir/jobdefs/FileSet + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-FileSet.rst.inc + + + +.. config:option:: dir/jobdefs/FullBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-FullBackupPool.rst.inc + + + +.. config:option:: dir/jobdefs/FullMaxRuntime + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-FullMaxRuntime.rst.inc + + + +.. config:option:: dir/jobdefs/FullMaxWaitTime + + :type: TIME + :version: deprecated + + .. include:: /config-directive-description/dir-jobdefs-FullMaxWaitTime.rst.inc + + + +.. config:option:: dir/jobdefs/IncrementalBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-IncrementalBackupPool.rst.inc + + + +.. config:option:: dir/jobdefs/IncrementalMaxRuntime + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-IncrementalMaxRuntime.rst.inc + + + +.. config:option:: dir/jobdefs/IncrementalMaxWaitTime + + :type: TIME + :version: deprecated + + .. include:: /config-directive-description/dir-jobdefs-IncrementalMaxWaitTime.rst.inc + + + +.. config:option:: dir/jobdefs/JobDefs + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-JobDefs.rst.inc + + + +.. config:option:: dir/jobdefs/JobToVerify + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-JobToVerify.rst.inc + + + +.. config:option:: dir/jobdefs/Level + + :type: BACKUP_LEVEL + + .. include:: /config-directive-description/dir-jobdefs-Level.rst.inc + + + +.. config:option:: dir/jobdefs/MaxConcurrentCopies + + :type: PINT32 + :default: 100 + + .. include:: /config-directive-description/dir-jobdefs-MaxConcurrentCopies.rst.inc + + + +.. config:option:: dir/jobdefs/MaxDiffInterval + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-MaxDiffInterval.rst.inc + + + +.. config:option:: dir/jobdefs/MaxFullConsolidations + + :type: PINT32 + :default: 0 + :version: 16.2.4 + + If "AlwaysIncrementalMaxFullAge" is configured, do not run more than "MaxFullConsolidations" consolidation jobs that include the Full backup. + + .. include:: /config-directive-description/dir-jobdefs-MaxFullConsolidations.rst.inc + + + +.. config:option:: dir/jobdefs/MaxFullInterval + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-MaxFullInterval.rst.inc + + + +.. config:option:: dir/jobdefs/MaxRunSchedTime + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-MaxRunSchedTime.rst.inc + + + +.. config:option:: dir/jobdefs/MaxRunTime + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-MaxRunTime.rst.inc + + + +.. config:option:: dir/jobdefs/MaxStartDelay + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-MaxStartDelay.rst.inc + + + +.. config:option:: dir/jobdefs/MaxVirtualFullInterval + + :type: TIME + :version: 14.4.0 + + .. include:: /config-directive-description/dir-jobdefs-MaxVirtualFullInterval.rst.inc + + + +.. config:option:: dir/jobdefs/MaxWaitTime + + :type: TIME + + .. include:: /config-directive-description/dir-jobdefs-MaxWaitTime.rst.inc + + + +.. config:option:: dir/jobdefs/MaximumBandwidth + + :type: SPEED + + .. include:: /config-directive-description/dir-jobdefs-MaximumBandwidth.rst.inc + + + +.. config:option:: dir/jobdefs/MaximumConcurrentJobs + + :type: PINT32 + :default: 1 + + .. include:: /config-directive-description/dir-jobdefs-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: dir/jobdefs/Messages + + :required: True + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-Messages.rst.inc + + + +.. config:option:: dir/jobdefs/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-jobdefs-Name.rst.inc + + + +.. config:option:: dir/jobdefs/NextPool + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-NextPool.rst.inc + + + +.. config:option:: dir/jobdefs/PluginOptions + + :type: STRING_LIST + :version: deprecated + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-jobdefs-PluginOptions.rst.inc + + + +.. config:option:: dir/jobdefs/Pool + + :required: True + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-Pool.rst.inc + + + +.. config:option:: dir/jobdefs/PreferMountedVolumes + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-jobdefs-PreferMountedVolumes.rst.inc + + + +.. config:option:: dir/jobdefs/PrefixLinks + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-PrefixLinks.rst.inc + + + +.. config:option:: dir/jobdefs/Priority + + :type: PINT32 + :default: 10 + + .. include:: /config-directive-description/dir-jobdefs-Priority.rst.inc + + + +.. config:option:: dir/jobdefs/Protocol + + :type: PROTOCOL_TYPE + :default: Native + + .. include:: /config-directive-description/dir-jobdefs-Protocol.rst.inc + + + +.. config:option:: dir/jobdefs/PruneFiles + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-PruneFiles.rst.inc + + + +.. config:option:: dir/jobdefs/PruneJobs + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-PruneJobs.rst.inc + + + +.. config:option:: dir/jobdefs/PruneVolumes + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-PruneVolumes.rst.inc + + + +.. config:option:: dir/jobdefs/PurgeMigrationJob + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-PurgeMigrationJob.rst.inc + + + +.. config:option:: dir/jobdefs/RegexWhere + + :type: STRING + + .. include:: /config-directive-description/dir-jobdefs-RegexWhere.rst.inc + + + +.. config:option:: dir/jobdefs/Replace + + :type: REPLACE_OPTION + :default: Always + + .. include:: /config-directive-description/dir-jobdefs-Replace.rst.inc + + + +.. config:option:: dir/jobdefs/RerunFailedLevels + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-RerunFailedLevels.rst.inc + + + +.. config:option:: dir/jobdefs/RescheduleInterval + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/dir-jobdefs-RescheduleInterval.rst.inc + + + +.. config:option:: dir/jobdefs/RescheduleOnError + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-RescheduleOnError.rst.inc + + + +.. config:option:: dir/jobdefs/RescheduleTimes + + :type: PINT32 + :default: 5 + + .. include:: /config-directive-description/dir-jobdefs-RescheduleTimes.rst.inc + + + +.. config:option:: dir/jobdefs/Run + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-jobdefs-Run.rst.inc + + + +.. config:option:: dir/jobdefs/RunAfterFailedJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-jobdefs-RunAfterFailedJob.rst.inc + + + +.. config:option:: dir/jobdefs/RunAfterJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-jobdefs-RunAfterJob.rst.inc + + + +.. config:option:: dir/jobdefs/RunBeforeJob + + :type: RUNSCRIPT_SHORT + + .. include:: /config-directive-description/dir-jobdefs-RunBeforeJob.rst.inc + + + +.. config:option:: dir/jobdefs/RunScript + + :type: RUNSCRIPT + + .. include:: /config-directive-description/dir-jobdefs-RunScript.rst.inc + + + +.. config:option:: dir/jobdefs/SaveFileHistory + + :type: BOOLEAN + :default: yes + :version: 14.2.0 + + .. include:: /config-directive-description/dir-jobdefs-SaveFileHistory.rst.inc + + + +.. config:option:: dir/jobdefs/Schedule + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-Schedule.rst.inc + + + +.. config:option:: dir/jobdefs/SdPluginOptions + + :type: STRING_LIST + + .. include:: /config-directive-description/dir-jobdefs-SdPluginOptions.rst.inc + + + +.. config:option:: dir/jobdefs/SelectionPattern + + :type: STRING + + .. include:: /config-directive-description/dir-jobdefs-SelectionPattern.rst.inc + + + +.. config:option:: dir/jobdefs/SelectionType + + :type: MIGRATION_TYPE + + .. include:: /config-directive-description/dir-jobdefs-SelectionType.rst.inc + + + +.. config:option:: dir/jobdefs/SpoolAttributes + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-SpoolAttributes.rst.inc + + + +.. config:option:: dir/jobdefs/SpoolData + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-jobdefs-SpoolData.rst.inc + + + +.. config:option:: dir/jobdefs/SpoolSize + + :type: SIZE64 + + .. include:: /config-directive-description/dir-jobdefs-SpoolSize.rst.inc + + + +.. config:option:: dir/jobdefs/Storage + + :type: RESOURCE_LIST + + .. include:: /config-directive-description/dir-jobdefs-Storage.rst.inc + + + +.. config:option:: dir/jobdefs/StripPrefix + + :type: STRING + + .. include:: /config-directive-description/dir-jobdefs-StripPrefix.rst.inc + + + +.. config:option:: dir/jobdefs/Type + + :required: True + :type: JOB_TYPE + + .. include:: /config-directive-description/dir-jobdefs-Type.rst.inc + + + +.. config:option:: dir/jobdefs/VerifyJob + + :type: RES + + *This directive is an alias.* + + .. include:: /config-directive-description/dir-jobdefs-VerifyJob.rst.inc + + + +.. config:option:: dir/jobdefs/VirtualFullBackupPool + + :type: RES + + .. include:: /config-directive-description/dir-jobdefs-VirtualFullBackupPool.rst.inc + + + +.. config:option:: dir/jobdefs/Where + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-jobdefs-Where.rst.inc + + + +.. config:option:: dir/jobdefs/WriteBootstrap + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-jobdefs-WriteBootstrap.rst.inc + + + +.. config:option:: dir/jobdefs/WritePartAfterJob + + :type: BOOLEAN + :version: deprecated + + .. include:: /config-directive-description/dir-jobdefs-WritePartAfterJob.rst.inc + + + +.. config:option:: dir/jobdefs/WriteVerifyList + + :type: DIRECTORY + + .. include:: /config-directive-description/dir-jobdefs-WriteVerifyList.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-messages-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-messages-description.rst.inc new file mode 100644 index 00000000000..746b4c2e33b --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-messages-description.rst.inc @@ -0,0 +1,136 @@ +.. config:option:: dir/messages/Append + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Append.rst.inc + + + +.. config:option:: dir/messages/Catalog + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Catalog.rst.inc + + + +.. config:option:: dir/messages/Console + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Console.rst.inc + + + +.. config:option:: dir/messages/Description + + :type: STRING + + .. include:: /config-directive-description/dir-messages-Description.rst.inc + + + +.. config:option:: dir/messages/Director + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Director.rst.inc + + + +.. config:option:: dir/messages/File + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-File.rst.inc + + + +.. config:option:: dir/messages/Mail + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Mail.rst.inc + + + +.. config:option:: dir/messages/MailCommand + + :type: STRING + + .. include:: /config-directive-description/dir-messages-MailCommand.rst.inc + + + +.. config:option:: dir/messages/MailOnError + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-MailOnError.rst.inc + + + +.. config:option:: dir/messages/MailOnSuccess + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-MailOnSuccess.rst.inc + + + +.. config:option:: dir/messages/Name + + :type: NAME + + .. include:: /config-directive-description/dir-messages-Name.rst.inc + + + +.. config:option:: dir/messages/Operator + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Operator.rst.inc + + + +.. config:option:: dir/messages/OperatorCommand + + :type: STRING + + .. include:: /config-directive-description/dir-messages-OperatorCommand.rst.inc + + + +.. config:option:: dir/messages/Stderr + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Stderr.rst.inc + + + +.. config:option:: dir/messages/Stdout + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Stdout.rst.inc + + + +.. config:option:: dir/messages/Syslog + + :type: MESSAGES + + .. include:: /config-directive-description/dir-messages-Syslog.rst.inc + + + +.. config:option:: dir/messages/TimestampFormat + + :type: STRING + + .. include:: /config-directive-description/dir-messages-TimestampFormat.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-pool-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-pool-description.rst.inc new file mode 100644 index 00000000000..1cd33a7af22 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-pool-description.rst.inc @@ -0,0 +1,279 @@ +.. config:option:: dir/pool/ActionOnPurge + + :type: ACTION_ON_PURGE + + .. include:: /config-directive-description/dir-pool-ActionOnPurge.rst.inc + + + +.. config:option:: dir/pool/AutoPrune + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-pool-AutoPrune.rst.inc + + + +.. config:option:: dir/pool/Catalog + + :type: RES + + .. include:: /config-directive-description/dir-pool-Catalog.rst.inc + + + +.. config:option:: dir/pool/CatalogFiles + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-pool-CatalogFiles.rst.inc + + + +.. config:option:: dir/pool/CleaningPrefix + + :type: STRNAME + :default: CLN + + .. include:: /config-directive-description/dir-pool-CleaningPrefix.rst.inc + + + +.. config:option:: dir/pool/Description + + :type: STRING + + .. include:: /config-directive-description/dir-pool-Description.rst.inc + + + +.. config:option:: dir/pool/FileRetention + + :type: TIME + + .. include:: /config-directive-description/dir-pool-FileRetention.rst.inc + + + +.. config:option:: dir/pool/JobRetention + + :type: TIME + + .. include:: /config-directive-description/dir-pool-JobRetention.rst.inc + + + +.. config:option:: dir/pool/LabelFormat + + :type: STRNAME + + .. include:: /config-directive-description/dir-pool-LabelFormat.rst.inc + + + +.. config:option:: dir/pool/LabelType + + :type: LABEL + + .. include:: /config-directive-description/dir-pool-LabelType.rst.inc + + + +.. config:option:: dir/pool/MaximumBlockSize + + :type: SIZE32 + :version: 14.2.0 + + .. include:: /config-directive-description/dir-pool-MaximumBlockSize.rst.inc + + + +.. config:option:: dir/pool/MaximumVolumeBytes + + :type: SIZE64 + + .. include:: /config-directive-description/dir-pool-MaximumVolumeBytes.rst.inc + + + +.. config:option:: dir/pool/MaximumVolumeFiles + + :type: PINT32 + + .. include:: /config-directive-description/dir-pool-MaximumVolumeFiles.rst.inc + + + +.. config:option:: dir/pool/MaximumVolumeJobs + + :type: PINT32 + + .. include:: /config-directive-description/dir-pool-MaximumVolumeJobs.rst.inc + + + +.. config:option:: dir/pool/MaximumVolumes + + :type: PINT32 + + .. include:: /config-directive-description/dir-pool-MaximumVolumes.rst.inc + + + +.. config:option:: dir/pool/MigrationHighBytes + + :type: SIZE64 + + .. include:: /config-directive-description/dir-pool-MigrationHighBytes.rst.inc + + + +.. config:option:: dir/pool/MigrationLowBytes + + :type: SIZE64 + + .. include:: /config-directive-description/dir-pool-MigrationLowBytes.rst.inc + + + +.. config:option:: dir/pool/MigrationTime + + :type: TIME + + .. include:: /config-directive-description/dir-pool-MigrationTime.rst.inc + + + +.. config:option:: dir/pool/MinimumBlockSize + + :type: SIZE32 + + .. include:: /config-directive-description/dir-pool-MinimumBlockSize.rst.inc + + + +.. config:option:: dir/pool/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-pool-Name.rst.inc + + + +.. config:option:: dir/pool/NextPool + + :type: RES + + .. include:: /config-directive-description/dir-pool-NextPool.rst.inc + + + +.. config:option:: dir/pool/PoolType + + :type: POOLTYPE + :default: Backup + + .. include:: /config-directive-description/dir-pool-PoolType.rst.inc + + + +.. config:option:: dir/pool/PurgeOldestVolume + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-pool-PurgeOldestVolume.rst.inc + + + +.. config:option:: dir/pool/Recycle + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-pool-Recycle.rst.inc + + + +.. config:option:: dir/pool/RecycleCurrentVolume + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-pool-RecycleCurrentVolume.rst.inc + + + +.. config:option:: dir/pool/RecycleOldestVolume + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-pool-RecycleOldestVolume.rst.inc + + + +.. config:option:: dir/pool/RecyclePool + + :type: RES + + .. include:: /config-directive-description/dir-pool-RecyclePool.rst.inc + + + +.. config:option:: dir/pool/ScratchPool + + :type: RES + + .. include:: /config-directive-description/dir-pool-ScratchPool.rst.inc + + + +.. config:option:: dir/pool/Storage + + :type: RESOURCE_LIST + + .. include:: /config-directive-description/dir-pool-Storage.rst.inc + + + +.. config:option:: dir/pool/UseCatalog + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-pool-UseCatalog.rst.inc + + + +.. config:option:: dir/pool/UseVolumeOnce + + :type: BOOLEAN + :version: deprecated + + .. include:: /config-directive-description/dir-pool-UseVolumeOnce.rst.inc + + + +.. config:option:: dir/pool/VolumeRetention + + :type: TIME + :default: 31536000 + + .. include:: /config-directive-description/dir-pool-VolumeRetention.rst.inc + + + +.. config:option:: dir/pool/VolumeUseDuration + + :type: TIME + + .. include:: /config-directive-description/dir-pool-VolumeUseDuration.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-profile-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-profile-description.rst.inc new file mode 100644 index 00000000000..a37f530149e --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-profile-description.rst.inc @@ -0,0 +1,121 @@ +.. config:option:: dir/profile/CatalogACL + + :type: ACL + + Lists the Catalog resources, this resource has access to. The special keyword *all* allows access to all Catalog resources. + + .. include:: /config-directive-description/dir-profile-CatalogACL.rst.inc + + + +.. config:option:: dir/profile/ClientACL + + :type: ACL + + Lists the Client resources, this resource has access to. The special keyword *all* allows access to all Client resources. + + .. include:: /config-directive-description/dir-profile-ClientACL.rst.inc + + + +.. config:option:: dir/profile/CommandACL + + :type: ACL + + Lists the commands, this resource has access to. The special keyword *all* allows using commands. + + .. include:: /config-directive-description/dir-profile-CommandACL.rst.inc + + + +.. config:option:: dir/profile/Description + + :type: STRING + + Additional information about the resource. Only used for UIs. + + .. include:: /config-directive-description/dir-profile-Description.rst.inc + + + +.. config:option:: dir/profile/FileSetACL + + :type: ACL + + Lists the File Set resources, this resource has access to. The special keyword *all* allows access to all File Set resources. + + .. include:: /config-directive-description/dir-profile-FileSetACL.rst.inc + + + +.. config:option:: dir/profile/JobACL + + :type: ACL + + Lists the Job resources, this resource has access to. The special keyword *all* allows access to all Job resources. + + .. include:: /config-directive-description/dir-profile-JobACL.rst.inc + + + +.. config:option:: dir/profile/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-profile-Name.rst.inc + + + +.. config:option:: dir/profile/PluginOptionsACL + + :type: ACL + + Specifies the allowed plugin options. An empty strings allows all Plugin Options. + + .. include:: /config-directive-description/dir-profile-PluginOptionsACL.rst.inc + + + +.. config:option:: dir/profile/PoolACL + + :type: ACL + + Lists the Pool resources, this resource has access to. The special keyword *all* allows access to all Pool resources. + + .. include:: /config-directive-description/dir-profile-PoolACL.rst.inc + + + +.. config:option:: dir/profile/ScheduleACL + + :type: ACL + + Lists the Schedule resources, this resource has access to. The special keyword *all* allows access to all Schedule resources. + + .. include:: /config-directive-description/dir-profile-ScheduleACL.rst.inc + + + +.. config:option:: dir/profile/StorageACL + + :type: ACL + + Lists the Storage resources, this resource has access to. The special keyword *all* allows access to all Storage resources. + + .. include:: /config-directive-description/dir-profile-StorageACL.rst.inc + + + +.. config:option:: dir/profile/WhereACL + + :type: ACL + + Specifies the base directories, where files could be restored. An empty string allows restores to all directories. + + .. include:: /config-directive-description/dir-profile-WhereACL.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-schedule-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-schedule-description.rst.inc new file mode 100644 index 00000000000..bad9b9d25b2 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-schedule-description.rst.inc @@ -0,0 +1,38 @@ +.. config:option:: dir/schedule/Description + + :type: STRING + + .. include:: /config-directive-description/dir-schedule-Description.rst.inc + + + +.. config:option:: dir/schedule/Enabled + + :type: BOOLEAN + :default: yes + + En- or disable this resource. + + .. include:: /config-directive-description/dir-schedule-Enabled.rst.inc + + + +.. config:option:: dir/schedule/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-schedule-Name.rst.inc + + + +.. config:option:: dir/schedule/Run + + :type: SCHEDULE_RUN_COMMAND + + .. include:: /config-directive-description/dir-schedule-Run.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-storage-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-storage-description.rst.inc new file mode 100644 index 00000000000..d488338aac8 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-storage-description.rst.inc @@ -0,0 +1,366 @@ +.. config:option:: dir/storage/Address + + :required: True + :type: STRING + + .. include:: /config-directive-description/dir-storage-Address.rst.inc + + + +.. config:option:: dir/storage/AllowCompression + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/dir-storage-AllowCompression.rst.inc + + + +.. config:option:: dir/storage/AuthType + + :type: AUTH_TYPE + :default: None + + .. include:: /config-directive-description/dir-storage-AuthType.rst.inc + + + +.. config:option:: dir/storage/AutoChanger + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-storage-AutoChanger.rst.inc + + + +.. config:option:: dir/storage/CacheStatusInterval + + :type: TIME + :default: 30 + + .. include:: /config-directive-description/dir-storage-CacheStatusInterval.rst.inc + + + +.. config:option:: dir/storage/CollectStatistics + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/dir-storage-CollectStatistics.rst.inc + + + +.. config:option:: dir/storage/Description + + :type: STRING + + .. include:: /config-directive-description/dir-storage-Description.rst.inc + + + +.. config:option:: dir/storage/Device + + :required: True + :type: DEVICE + + .. include:: /config-directive-description/dir-storage-Device.rst.inc + + + +.. config:option:: dir/storage/Enabled + + :type: BOOLEAN + :default: yes + + En- or disable this resource. + + .. include:: /config-directive-description/dir-storage-Enabled.rst.inc + + + +.. config:option:: dir/storage/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/dir-storage-HeartbeatInterval.rst.inc + + + +.. config:option:: dir/storage/LanAddress + + :type: STRING + :version: 16.2.6 + + Sets additional address used for connections between Client and Storage Daemon inside separate network. + + .. include:: /config-directive-description/dir-storage-LanAddress.rst.inc + + + +.. config:option:: dir/storage/MaximumBandwidthPerJob + + :type: SPEED + + .. include:: /config-directive-description/dir-storage-MaximumBandwidthPerJob.rst.inc + + + +.. config:option:: dir/storage/MaximumConcurrentJobs + + :type: PINT32 + :default: 1 + + .. include:: /config-directive-description/dir-storage-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: dir/storage/MaximumConcurrentReadJobs + + :type: PINT32 + :default: 0 + + .. include:: /config-directive-description/dir-storage-MaximumConcurrentReadJobs.rst.inc + + + +.. config:option:: dir/storage/MediaType + + :required: True + :type: STRNAME + + .. include:: /config-directive-description/dir-storage-MediaType.rst.inc + + + +.. config:option:: dir/storage/Name + + :required: True + :type: NAME + + The name of the resource. + + .. include:: /config-directive-description/dir-storage-Name.rst.inc + + + +.. config:option:: dir/storage/NdmpChangerDevice + + :type: STRNAME + :version: 16.2.4 + + Allows direct control of a Storage Daemon Auto Changer device by the Director. Only used in NDMP_NATIVE environments. + + .. include:: /config-directive-description/dir-storage-NdmpChangerDevice.rst.inc + + + +.. config:option:: dir/storage/PairedStorage + + :type: RES + + .. include:: /config-directive-description/dir-storage-PairedStorage.rst.inc + + + +.. config:option:: dir/storage/Password + + :required: True + :type: AUTOPASSWORD + + .. include:: /config-directive-description/dir-storage-Password.rst.inc + + + +.. config:option:: dir/storage/Port + + :type: PINT32 + :default: 9103 + + .. include:: /config-directive-description/dir-storage-Port.rst.inc + + + +.. config:option:: dir/storage/Protocol + + :type: AUTH_PROTOCOL_TYPE + :default: Native + + .. include:: /config-directive-description/dir-storage-Protocol.rst.inc + + + +.. config:option:: dir/storage/SdAddress + + :type: STRING + + Alias for Address. + + .. include:: /config-directive-description/dir-storage-SdAddress.rst.inc + + + +.. config:option:: dir/storage/SdPassword + + :type: AUTOPASSWORD + + Alias for Password. + + .. include:: /config-directive-description/dir-storage-SdPassword.rst.inc + + + +.. config:option:: dir/storage/SdPort + + :type: PINT32 + :default: 9103 + + Alias for Port. + + .. include:: /config-directive-description/dir-storage-SdPort.rst.inc + + + +.. config:option:: dir/storage/SddPort + + :type: PINT32 + :version: deprecated + + .. include:: /config-directive-description/dir-storage-SddPort.rst.inc + + + +.. config:option:: dir/storage/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/dir-storage-TlsAllowedCn.rst.inc + + + +.. config:option:: dir/storage/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/dir-storage-TlsAuthenticate.rst.inc + + + +.. config:option:: dir/storage/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/dir-storage-TlsCaCertificateDir.rst.inc + + + +.. config:option:: dir/storage/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/dir-storage-TlsCaCertificateFile.rst.inc + + + +.. config:option:: dir/storage/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/dir-storage-TlsCertificate.rst.inc + + + +.. config:option:: dir/storage/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/dir-storage-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: dir/storage/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/dir-storage-TlsCipherList.rst.inc + + + +.. config:option:: dir/storage/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/dir-storage-TlsDhFile.rst.inc + + + +.. config:option:: dir/storage/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/dir-storage-TlsEnable.rst.inc + + + +.. config:option:: dir/storage/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/dir-storage-TlsKey.rst.inc + + + +.. config:option:: dir/storage/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/dir-storage-TlsRequire.rst.inc + + + +.. config:option:: dir/storage/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/dir-storage-TlsVerifyPeer.rst.inc + + + +.. config:option:: dir/storage/Username + + :type: STRING + + .. include:: /config-directive-description/dir-storage-Username.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-user-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-user-description.rst.inc new file mode 100644 index 00000000000..29402c3e043 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-dir-resource-user-description.rst.inc @@ -0,0 +1,259 @@ +.. config:option:: dir/user/CatalogACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-CatalogACL.rst.inc + + + +.. config:option:: dir/user/ClientACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-ClientACL.rst.inc + + + +.. config:option:: dir/user/CommandACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-CommandACL.rst.inc + + + +.. config:option:: dir/user/Description + + :type: STRING + + .. include:: /config-directive-description/dir-user-Description.rst.inc + + + +.. config:option:: dir/user/FileSetACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-FileSetACL.rst.inc + + + +.. config:option:: dir/user/JobACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-JobACL.rst.inc + + + +.. config:option:: dir/user/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/dir-user-Name.rst.inc + + + +.. config:option:: dir/user/Password + + :required: True + :type: AUTOPASSWORD + + .. include:: /config-directive-description/dir-user-Password.rst.inc + + + +.. config:option:: dir/user/PluginOptionsACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-PluginOptionsACL.rst.inc + + + +.. config:option:: dir/user/PoolACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-PoolACL.rst.inc + + + +.. config:option:: dir/user/Profile + + :type: RESOURCE_LIST + :version: 14.2.3 + + Profiles can be assigned to a Console. ACL are checked until either a deny ACL is found or an allow ACL. First the console ACL is checked then any profile the console is linked to. + + .. include:: /config-directive-description/dir-user-Profile.rst.inc + + + +.. config:option:: dir/user/RunACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-RunACL.rst.inc + + + +.. config:option:: dir/user/ScheduleACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-ScheduleACL.rst.inc + + + +.. config:option:: dir/user/StorageACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-StorageACL.rst.inc + + + +.. config:option:: dir/user/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/dir-user-TlsAllowedCn.rst.inc + + + +.. config:option:: dir/user/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/dir-user-TlsAuthenticate.rst.inc + + + +.. config:option:: dir/user/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/dir-user-TlsCaCertificateDir.rst.inc + + + +.. config:option:: dir/user/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/dir-user-TlsCaCertificateFile.rst.inc + + + +.. config:option:: dir/user/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/dir-user-TlsCertificate.rst.inc + + + +.. config:option:: dir/user/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/dir-user-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: dir/user/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/dir-user-TlsCipherList.rst.inc + + + +.. config:option:: dir/user/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/dir-user-TlsDhFile.rst.inc + + + +.. config:option:: dir/user/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/dir-user-TlsEnable.rst.inc + + + +.. config:option:: dir/user/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/dir-user-TlsKey.rst.inc + + + +.. config:option:: dir/user/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/dir-user-TlsRequire.rst.inc + + + +.. config:option:: dir/user/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/dir-user-TlsVerifyPeer.rst.inc + + + +.. config:option:: dir/user/UsePamAuthentication + + :type: BOOLEAN + :default: no + :version: 18.2.4 + + .. include:: /config-directive-description/dir-user-UsePamAuthentication.rst.inc + + + +.. config:option:: dir/user/WhereACL + + :type: ACL + + .. include:: /config-directive-description/dir-user-WhereACL.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-client-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-client-description.rst.inc new file mode 100644 index 00000000000..d0afd324c24 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-client-description.rst.inc @@ -0,0 +1,441 @@ +.. config:option:: fd/client/AbsoluteJobTimeout + + :type: PINT32 + + .. include:: /config-directive-description/fd-client-AbsoluteJobTimeout.rst.inc + + + +.. config:option:: fd/client/AllowBandwidthBursting + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/fd-client-AllowBandwidthBursting.rst.inc + + + +.. config:option:: fd/client/AllowedJobCommand + + :type: STRING_LIST + + .. include:: /config-directive-description/fd-client-AllowedJobCommand.rst.inc + + + +.. config:option:: fd/client/AllowedScriptDir + + :type: DIRECTORY_LIST + + .. include:: /config-directive-description/fd-client-AllowedScriptDir.rst.inc + + + +.. config:option:: fd/client/AlwaysUseLmdb + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/fd-client-AlwaysUseLmdb.rst.inc + + + +.. config:option:: fd/client/Compatible + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/fd-client-Compatible.rst.inc + + + +.. config:option:: fd/client/Description + + :type: STRING + + .. include:: /config-directive-description/fd-client-Description.rst.inc + + + +.. config:option:: fd/client/FdAddress + + :type: ADDRESS + :default: 9102 + + .. include:: /config-directive-description/fd-client-FdAddress.rst.inc + + + +.. config:option:: fd/client/FdAddresses + + :type: ADDRESSES + :default: 9102 + + .. include:: /config-directive-description/fd-client-FdAddresses.rst.inc + + + +.. config:option:: fd/client/FdPort + + :type: PORT + :default: 9102 + + .. include:: /config-directive-description/fd-client-FdPort.rst.inc + + + +.. config:option:: fd/client/FdSourceAddress + + :type: ADDRESS + :default: 0 + + .. include:: /config-directive-description/fd-client-FdSourceAddress.rst.inc + + + +.. config:option:: fd/client/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/fd-client-HeartbeatInterval.rst.inc + + + +.. config:option:: fd/client/LmdbThreshold + + :type: PINT32 + + .. include:: /config-directive-description/fd-client-LmdbThreshold.rst.inc + + + +.. config:option:: fd/client/LogTimestampFormat + + :type: STRING + :version: 15.2.3 + + .. include:: /config-directive-description/fd-client-LogTimestampFormat.rst.inc + + + +.. config:option:: fd/client/MaximumBandwidthPerJob + + :type: SPEED + + .. include:: /config-directive-description/fd-client-MaximumBandwidthPerJob.rst.inc + + + +.. config:option:: fd/client/MaximumConcurrentJobs + + :type: PINT32 + :default: 20 + + .. include:: /config-directive-description/fd-client-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: fd/client/MaximumConnections + + :type: PINT32 + :default: 42 + :version: 15.2.3 + + .. include:: /config-directive-description/fd-client-MaximumConnections.rst.inc + + + +.. config:option:: fd/client/MaximumNetworkBufferSize + + :type: PINT32 + + .. include:: /config-directive-description/fd-client-MaximumNetworkBufferSize.rst.inc + + + +.. config:option:: fd/client/Messages + + :type: RES + + .. include:: /config-directive-description/fd-client-Messages.rst.inc + + + +.. config:option:: fd/client/Name + + :required: True + :type: NAME + + The name of this resource. It is used to reference to it. + + .. include:: /config-directive-description/fd-client-Name.rst.inc + + + +.. config:option:: fd/client/PidDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/fd-client-PidDirectory.rst.inc + + + +.. config:option:: fd/client/PkiCipher + + :type: ENCRYPTION_CIPHER + :default: aes128 + + PKI Cipher used for data encryption. + + .. include:: /config-directive-description/fd-client-PkiCipher.rst.inc + + + +.. config:option:: fd/client/PkiEncryption + + :type: BOOLEAN + :default: no + + Enable Data Encryption. + + .. include:: /config-directive-description/fd-client-PkiEncryption.rst.inc + + + +.. config:option:: fd/client/PkiKeyPair + + :type: DIRECTORY + + File with public and private key to sign, encrypt (backup) and decrypt (restore) the data. + + .. include:: /config-directive-description/fd-client-PkiKeyPair.rst.inc + + + +.. config:option:: fd/client/PkiMasterKey + + :type: DIRECTORY_LIST + + List of public key files. Data will be decryptable via the corresponding private keys. + + .. include:: /config-directive-description/fd-client-PkiMasterKey.rst.inc + + + +.. config:option:: fd/client/PkiSignatures + + :type: BOOLEAN + :default: no + + Enable Data Signing. + + .. include:: /config-directive-description/fd-client-PkiSignatures.rst.inc + + + +.. config:option:: fd/client/PkiSigner + + :type: DIRECTORY_LIST + + Additional public/private key files to sign or verify the data. + + .. include:: /config-directive-description/fd-client-PkiSigner.rst.inc + + + +.. config:option:: fd/client/PluginDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/fd-client-PluginDirectory.rst.inc + + + +.. config:option:: fd/client/PluginNames + + :type: PLUGIN_NAMES + + .. include:: /config-directive-description/fd-client-PluginNames.rst.inc + + + +.. config:option:: fd/client/ScriptsDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/fd-client-ScriptsDirectory.rst.inc + + + +.. config:option:: fd/client/SdConnectTimeout + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/fd-client-SdConnectTimeout.rst.inc + + + +.. config:option:: fd/client/SecureEraseCommand + + :type: STRING + :version: 15.2.1 + + Specify command that will be called when bareos unlinks files. + + .. include:: /config-directive-description/fd-client-SecureEraseCommand.rst.inc + + + +.. config:option:: fd/client/SubSysDirectory + + :type: DIRECTORY + :version: deprecated + + .. include:: /config-directive-description/fd-client-SubSysDirectory.rst.inc + + + +.. config:option:: fd/client/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/fd-client-TlsAllowedCn.rst.inc + + + +.. config:option:: fd/client/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/fd-client-TlsAuthenticate.rst.inc + + + +.. config:option:: fd/client/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/fd-client-TlsCaCertificateDir.rst.inc + + + +.. config:option:: fd/client/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/fd-client-TlsCaCertificateFile.rst.inc + + + +.. config:option:: fd/client/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/fd-client-TlsCertificate.rst.inc + + + +.. config:option:: fd/client/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/fd-client-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: fd/client/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/fd-client-TlsCipherList.rst.inc + + + +.. config:option:: fd/client/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/fd-client-TlsDhFile.rst.inc + + + +.. config:option:: fd/client/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/fd-client-TlsEnable.rst.inc + + + +.. config:option:: fd/client/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/fd-client-TlsKey.rst.inc + + + +.. config:option:: fd/client/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/fd-client-TlsRequire.rst.inc + + + +.. config:option:: fd/client/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/fd-client-TlsVerifyPeer.rst.inc + + + +.. config:option:: fd/client/VerId + + :type: STRING + + .. include:: /config-directive-description/fd-client-VerId.rst.inc + + + +.. config:option:: fd/client/WorkingDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/fd-client-WorkingDirectory.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-director-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-director-description.rst.inc new file mode 100644 index 00000000000..20a0da23329 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-director-description.rst.inc @@ -0,0 +1,229 @@ +.. config:option:: fd/director/Address + + :type: STRING + + Director Network Address. Only required if "Connection From Client To Director" is enabled. + + .. include:: /config-directive-description/fd-director-Address.rst.inc + + + +.. config:option:: fd/director/AllowedJobCommand + + :type: STRING_LIST + + .. include:: /config-directive-description/fd-director-AllowedJobCommand.rst.inc + + + +.. config:option:: fd/director/AllowedScriptDir + + :type: DIRECTORY_LIST + + .. include:: /config-directive-description/fd-director-AllowedScriptDir.rst.inc + + + +.. config:option:: fd/director/ConnectionFromClientToDirector + + :type: BOOLEAN + :default: no + :version: 16.2.2 + + Let the Filedaemon initiate network connections to the Director. + + .. include:: /config-directive-description/fd-director-ConnectionFromClientToDirector.rst.inc + + + +.. config:option:: fd/director/ConnectionFromDirectorToClient + + :type: BOOLEAN + :default: yes + :version: 16.2.2 + + This Client will accept incoming network connection from this Director. + + .. include:: /config-directive-description/fd-director-ConnectionFromDirectorToClient.rst.inc + + + +.. config:option:: fd/director/Description + + :type: STRING + + .. include:: /config-directive-description/fd-director-Description.rst.inc + + + +.. config:option:: fd/director/MaximumBandwidthPerJob + + :type: SPEED + + .. include:: /config-directive-description/fd-director-MaximumBandwidthPerJob.rst.inc + + + +.. config:option:: fd/director/Monitor + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/fd-director-Monitor.rst.inc + + + +.. config:option:: fd/director/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/fd-director-Name.rst.inc + + + +.. config:option:: fd/director/Password + + :required: True + :type: MD5PASSWORD + + .. include:: /config-directive-description/fd-director-Password.rst.inc + + + +.. config:option:: fd/director/Port + + :type: PINT32 + :default: 9101 + :version: 16.2.2 + + Director Network Port. Only used if "Connection From Client To Director" is enabled. + + .. include:: /config-directive-description/fd-director-Port.rst.inc + + + +.. config:option:: fd/director/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/fd-director-TlsAllowedCn.rst.inc + + + +.. config:option:: fd/director/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/fd-director-TlsAuthenticate.rst.inc + + + +.. config:option:: fd/director/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/fd-director-TlsCaCertificateDir.rst.inc + + + +.. config:option:: fd/director/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/fd-director-TlsCaCertificateFile.rst.inc + + + +.. config:option:: fd/director/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/fd-director-TlsCertificate.rst.inc + + + +.. config:option:: fd/director/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/fd-director-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: fd/director/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/fd-director-TlsCipherList.rst.inc + + + +.. config:option:: fd/director/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/fd-director-TlsDhFile.rst.inc + + + +.. config:option:: fd/director/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/fd-director-TlsEnable.rst.inc + + + +.. config:option:: fd/director/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/fd-director-TlsKey.rst.inc + + + +.. config:option:: fd/director/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/fd-director-TlsRequire.rst.inc + + + +.. config:option:: fd/director/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/fd-director-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-filedaemon-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-filedaemon-description.rst.inc new file mode 100644 index 00000000000..07cdcb28b83 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-filedaemon-description.rst.inc @@ -0,0 +1,441 @@ +.. config:option:: fd/filedaemon/AbsoluteJobTimeout + + :type: PINT32 + + .. include:: /config-directive-description/fd-filedaemon-AbsoluteJobTimeout.rst.inc + + + +.. config:option:: fd/filedaemon/AllowBandwidthBursting + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/fd-filedaemon-AllowBandwidthBursting.rst.inc + + + +.. config:option:: fd/filedaemon/AllowedJobCommand + + :type: STRING_LIST + + .. include:: /config-directive-description/fd-filedaemon-AllowedJobCommand.rst.inc + + + +.. config:option:: fd/filedaemon/AllowedScriptDir + + :type: DIRECTORY_LIST + + .. include:: /config-directive-description/fd-filedaemon-AllowedScriptDir.rst.inc + + + +.. config:option:: fd/filedaemon/AlwaysUseLmdb + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/fd-filedaemon-AlwaysUseLmdb.rst.inc + + + +.. config:option:: fd/filedaemon/Compatible + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/fd-filedaemon-Compatible.rst.inc + + + +.. config:option:: fd/filedaemon/Description + + :type: STRING + + .. include:: /config-directive-description/fd-filedaemon-Description.rst.inc + + + +.. config:option:: fd/filedaemon/FdAddress + + :type: ADDRESS + :default: 9102 + + .. include:: /config-directive-description/fd-filedaemon-FdAddress.rst.inc + + + +.. config:option:: fd/filedaemon/FdAddresses + + :type: ADDRESSES + :default: 9102 + + .. include:: /config-directive-description/fd-filedaemon-FdAddresses.rst.inc + + + +.. config:option:: fd/filedaemon/FdPort + + :type: PORT + :default: 9102 + + .. include:: /config-directive-description/fd-filedaemon-FdPort.rst.inc + + + +.. config:option:: fd/filedaemon/FdSourceAddress + + :type: ADDRESS + :default: 0 + + .. include:: /config-directive-description/fd-filedaemon-FdSourceAddress.rst.inc + + + +.. config:option:: fd/filedaemon/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/fd-filedaemon-HeartbeatInterval.rst.inc + + + +.. config:option:: fd/filedaemon/LmdbThreshold + + :type: PINT32 + + .. include:: /config-directive-description/fd-filedaemon-LmdbThreshold.rst.inc + + + +.. config:option:: fd/filedaemon/LogTimestampFormat + + :type: STRING + :version: 15.2.3 + + .. include:: /config-directive-description/fd-filedaemon-LogTimestampFormat.rst.inc + + + +.. config:option:: fd/filedaemon/MaximumBandwidthPerJob + + :type: SPEED + + .. include:: /config-directive-description/fd-filedaemon-MaximumBandwidthPerJob.rst.inc + + + +.. config:option:: fd/filedaemon/MaximumConcurrentJobs + + :type: PINT32 + :default: 20 + + .. include:: /config-directive-description/fd-filedaemon-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: fd/filedaemon/MaximumConnections + + :type: PINT32 + :default: 42 + :version: 15.2.3 + + .. include:: /config-directive-description/fd-filedaemon-MaximumConnections.rst.inc + + + +.. config:option:: fd/filedaemon/MaximumNetworkBufferSize + + :type: PINT32 + + .. include:: /config-directive-description/fd-filedaemon-MaximumNetworkBufferSize.rst.inc + + + +.. config:option:: fd/filedaemon/Messages + + :type: RES + + .. include:: /config-directive-description/fd-filedaemon-Messages.rst.inc + + + +.. config:option:: fd/filedaemon/Name + + :required: True + :type: NAME + + The name of this resource. It is used to reference to it. + + .. include:: /config-directive-description/fd-filedaemon-Name.rst.inc + + + +.. config:option:: fd/filedaemon/PidDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/fd-filedaemon-PidDirectory.rst.inc + + + +.. config:option:: fd/filedaemon/PkiCipher + + :type: ENCRYPTION_CIPHER + :default: aes128 + + PKI Cipher used for data encryption. + + .. include:: /config-directive-description/fd-filedaemon-PkiCipher.rst.inc + + + +.. config:option:: fd/filedaemon/PkiEncryption + + :type: BOOLEAN + :default: no + + Enable Data Encryption. + + .. include:: /config-directive-description/fd-filedaemon-PkiEncryption.rst.inc + + + +.. config:option:: fd/filedaemon/PkiKeyPair + + :type: DIRECTORY + + File with public and private key to sign, encrypt (backup) and decrypt (restore) the data. + + .. include:: /config-directive-description/fd-filedaemon-PkiKeyPair.rst.inc + + + +.. config:option:: fd/filedaemon/PkiMasterKey + + :type: DIRECTORY_LIST + + List of public key files. Data will be decryptable via the corresponding private keys. + + .. include:: /config-directive-description/fd-filedaemon-PkiMasterKey.rst.inc + + + +.. config:option:: fd/filedaemon/PkiSignatures + + :type: BOOLEAN + :default: no + + Enable Data Signing. + + .. include:: /config-directive-description/fd-filedaemon-PkiSignatures.rst.inc + + + +.. config:option:: fd/filedaemon/PkiSigner + + :type: DIRECTORY_LIST + + Additional public/private key files to sign or verify the data. + + .. include:: /config-directive-description/fd-filedaemon-PkiSigner.rst.inc + + + +.. config:option:: fd/filedaemon/PluginDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/fd-filedaemon-PluginDirectory.rst.inc + + + +.. config:option:: fd/filedaemon/PluginNames + + :type: PLUGIN_NAMES + + .. include:: /config-directive-description/fd-filedaemon-PluginNames.rst.inc + + + +.. config:option:: fd/filedaemon/ScriptsDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/fd-filedaemon-ScriptsDirectory.rst.inc + + + +.. config:option:: fd/filedaemon/SdConnectTimeout + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/fd-filedaemon-SdConnectTimeout.rst.inc + + + +.. config:option:: fd/filedaemon/SecureEraseCommand + + :type: STRING + :version: 15.2.1 + + Specify command that will be called when bareos unlinks files. + + .. include:: /config-directive-description/fd-filedaemon-SecureEraseCommand.rst.inc + + + +.. config:option:: fd/filedaemon/SubSysDirectory + + :type: DIRECTORY + :version: deprecated + + .. include:: /config-directive-description/fd-filedaemon-SubSysDirectory.rst.inc + + + +.. config:option:: fd/filedaemon/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/fd-filedaemon-TlsAllowedCn.rst.inc + + + +.. config:option:: fd/filedaemon/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/fd-filedaemon-TlsAuthenticate.rst.inc + + + +.. config:option:: fd/filedaemon/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/fd-filedaemon-TlsCaCertificateDir.rst.inc + + + +.. config:option:: fd/filedaemon/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/fd-filedaemon-TlsCaCertificateFile.rst.inc + + + +.. config:option:: fd/filedaemon/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/fd-filedaemon-TlsCertificate.rst.inc + + + +.. config:option:: fd/filedaemon/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/fd-filedaemon-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: fd/filedaemon/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/fd-filedaemon-TlsCipherList.rst.inc + + + +.. config:option:: fd/filedaemon/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/fd-filedaemon-TlsDhFile.rst.inc + + + +.. config:option:: fd/filedaemon/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/fd-filedaemon-TlsEnable.rst.inc + + + +.. config:option:: fd/filedaemon/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/fd-filedaemon-TlsKey.rst.inc + + + +.. config:option:: fd/filedaemon/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/fd-filedaemon-TlsRequire.rst.inc + + + +.. config:option:: fd/filedaemon/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/fd-filedaemon-TlsVerifyPeer.rst.inc + + + +.. config:option:: fd/filedaemon/VerId + + :type: STRING + + .. include:: /config-directive-description/fd-filedaemon-VerId.rst.inc + + + +.. config:option:: fd/filedaemon/WorkingDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/fd-filedaemon-WorkingDirectory.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-messages-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-messages-description.rst.inc new file mode 100644 index 00000000000..67d29a8f6c4 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-fd-resource-messages-description.rst.inc @@ -0,0 +1,136 @@ +.. config:option:: fd/messages/Append + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Append.rst.inc + + + +.. config:option:: fd/messages/Catalog + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Catalog.rst.inc + + + +.. config:option:: fd/messages/Console + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Console.rst.inc + + + +.. config:option:: fd/messages/Description + + :type: STRING + + .. include:: /config-directive-description/fd-messages-Description.rst.inc + + + +.. config:option:: fd/messages/Director + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Director.rst.inc + + + +.. config:option:: fd/messages/File + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-File.rst.inc + + + +.. config:option:: fd/messages/Mail + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Mail.rst.inc + + + +.. config:option:: fd/messages/MailCommand + + :type: STRING + + .. include:: /config-directive-description/fd-messages-MailCommand.rst.inc + + + +.. config:option:: fd/messages/MailOnError + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-MailOnError.rst.inc + + + +.. config:option:: fd/messages/MailOnSuccess + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-MailOnSuccess.rst.inc + + + +.. config:option:: fd/messages/Name + + :type: NAME + + .. include:: /config-directive-description/fd-messages-Name.rst.inc + + + +.. config:option:: fd/messages/Operator + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Operator.rst.inc + + + +.. config:option:: fd/messages/OperatorCommand + + :type: STRING + + .. include:: /config-directive-description/fd-messages-OperatorCommand.rst.inc + + + +.. config:option:: fd/messages/Stderr + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Stderr.rst.inc + + + +.. config:option:: fd/messages/Stdout + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Stdout.rst.inc + + + +.. config:option:: fd/messages/Syslog + + :type: MESSAGES + + .. include:: /config-directive-description/fd-messages-Syslog.rst.inc + + + +.. config:option:: fd/messages/TimestampFormat + + :type: STRING + + .. include:: /config-directive-description/fd-messages-TimestampFormat.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-autochanger-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-autochanger-description.rst.inc new file mode 100644 index 00000000000..7bdb35cd706 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-autochanger-description.rst.inc @@ -0,0 +1,44 @@ +.. config:option:: sd/autochanger/ChangerCommand + + :required: True + :type: STRNAME + + .. include:: /config-directive-description/sd-autochanger-ChangerCommand.rst.inc + + + +.. config:option:: sd/autochanger/ChangerDevice + + :required: True + :type: STRNAME + + .. include:: /config-directive-description/sd-autochanger-ChangerDevice.rst.inc + + + +.. config:option:: sd/autochanger/Description + + :type: STRING + + .. include:: /config-directive-description/sd-autochanger-Description.rst.inc + + + +.. config:option:: sd/autochanger/Device + + :required: True + :type: RESOURCE_LIST + + .. include:: /config-directive-description/sd-autochanger-Device.rst.inc + + + +.. config:option:: sd/autochanger/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/sd-autochanger-Name.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-device-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-device-description.rst.inc new file mode 100644 index 00000000000..ff1fad1bce8 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-device-description.rst.inc @@ -0,0 +1,588 @@ +.. config:option:: sd/device/AlertCommand + + :type: STRNAME + + .. include:: /config-directive-description/sd-device-AlertCommand.rst.inc + + + +.. config:option:: sd/device/AlwaysOpen + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-AlwaysOpen.rst.inc + + + +.. config:option:: sd/device/ArchiveDevice + + :required: True + :type: STRNAME + + .. include:: /config-directive-description/sd-device-ArchiveDevice.rst.inc + + + +.. config:option:: sd/device/AutoDeflate + + :type: IO_DIRECTION + :version: 13.4.0 + + .. include:: /config-directive-description/sd-device-AutoDeflate.rst.inc + + + +.. config:option:: sd/device/AutoDeflateAlgorithm + + :type: COMPRESSION_ALGORITHM + :version: 13.4.0 + + .. include:: /config-directive-description/sd-device-AutoDeflateAlgorithm.rst.inc + + + +.. config:option:: sd/device/AutoDeflateLevel + + :type: PINT16 + :default: 6 + :version: 13.4.0 + + .. include:: /config-directive-description/sd-device-AutoDeflateLevel.rst.inc + + + +.. config:option:: sd/device/AutoInflate + + :type: IO_DIRECTION + :version: 13.4.0 + + .. include:: /config-directive-description/sd-device-AutoInflate.rst.inc + + + +.. config:option:: sd/device/AutoSelect + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/sd-device-AutoSelect.rst.inc + + + +.. config:option:: sd/device/Autochanger + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-Autochanger.rst.inc + + + +.. config:option:: sd/device/AutomaticMount + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-AutomaticMount.rst.inc + + + +.. config:option:: sd/device/BackwardSpaceFile + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-BackwardSpaceFile.rst.inc + + + +.. config:option:: sd/device/BackwardSpaceRecord + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-BackwardSpaceRecord.rst.inc + + + +.. config:option:: sd/device/BlockChecksum + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-BlockChecksum.rst.inc + + + +.. config:option:: sd/device/BlockPositioning + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-BlockPositioning.rst.inc + + + +.. config:option:: sd/device/BsfAtEom + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-BsfAtEom.rst.inc + + + +.. config:option:: sd/device/ChangerCommand + + :type: STRNAME + + .. include:: /config-directive-description/sd-device-ChangerCommand.rst.inc + + + +.. config:option:: sd/device/ChangerDevice + + :type: STRNAME + + .. include:: /config-directive-description/sd-device-ChangerDevice.rst.inc + + + +.. config:option:: sd/device/CheckLabels + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-CheckLabels.rst.inc + + + +.. config:option:: sd/device/CloseOnPoll + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-CloseOnPoll.rst.inc + + + +.. config:option:: sd/device/CollectStatistics + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/sd-device-CollectStatistics.rst.inc + + + +.. config:option:: sd/device/Description + + :type: STRING + + The Description directive provides easier human recognition, but is not used by Bareos directly. + + .. include:: /config-directive-description/sd-device-Description.rst.inc + + + +.. config:option:: sd/device/DeviceOptions + + :type: STRING + :version: 15.2.0 + + .. include:: /config-directive-description/sd-device-DeviceOptions.rst.inc + + + +.. config:option:: sd/device/DeviceType + + :type: DEVICE_TYPE + + .. include:: /config-directive-description/sd-device-DeviceType.rst.inc + + + +.. config:option:: sd/device/DiagnosticDevice + + :type: STRNAME + + .. include:: /config-directive-description/sd-device-DiagnosticDevice.rst.inc + + + +.. config:option:: sd/device/DriveCryptoEnabled + + :type: BOOLEAN + + .. include:: /config-directive-description/sd-device-DriveCryptoEnabled.rst.inc + + + +.. config:option:: sd/device/DriveIndex + + :type: PINT16 + + .. include:: /config-directive-description/sd-device-DriveIndex.rst.inc + + + +.. config:option:: sd/device/DriveTapeAlertEnabled + + :type: BOOLEAN + + .. include:: /config-directive-description/sd-device-DriveTapeAlertEnabled.rst.inc + + + +.. config:option:: sd/device/EofOnErrorIsEot + + :type: BOOLEAN + :version: 18.2.4 + + If Yes, Bareos will treat any read error at an end-of-file mark as end-of-tape. You should only set this option if your tape-drive fails to detect end-of-tape while reading. + + .. include:: /config-directive-description/sd-device-EofOnErrorIsEot.rst.inc + + + +.. config:option:: sd/device/FastForwardSpaceFile + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-FastForwardSpaceFile.rst.inc + + + +.. config:option:: sd/device/ForwardSpaceFile + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-ForwardSpaceFile.rst.inc + + + +.. config:option:: sd/device/ForwardSpaceRecord + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-ForwardSpaceRecord.rst.inc + + + +.. config:option:: sd/device/FreeSpaceCommand + + :type: STRNAME + :version: deprecated + + .. include:: /config-directive-description/sd-device-FreeSpaceCommand.rst.inc + + + +.. config:option:: sd/device/HardwareEndOfFile + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-HardwareEndOfFile.rst.inc + + + +.. config:option:: sd/device/HardwareEndOfMedium + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-HardwareEndOfMedium.rst.inc + + + +.. config:option:: sd/device/LabelBlockSize + + :type: PINT32 + :default: 64512 + + .. include:: /config-directive-description/sd-device-LabelBlockSize.rst.inc + + + +.. config:option:: sd/device/LabelMedia + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-LabelMedia.rst.inc + + + +.. config:option:: sd/device/LabelType + + :type: LABEL + + .. include:: /config-directive-description/sd-device-LabelType.rst.inc + + + +.. config:option:: sd/device/MaximumBlockSize + + :type: MAX_BLOCKSIZE + + .. include:: /config-directive-description/sd-device-MaximumBlockSize.rst.inc + + + +.. config:option:: sd/device/MaximumChangerWait + + :type: TIME + :default: 300 + + .. include:: /config-directive-description/sd-device-MaximumChangerWait.rst.inc + + + +.. config:option:: sd/device/MaximumConcurrentJobs + + :type: PINT32 + + .. include:: /config-directive-description/sd-device-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: sd/device/MaximumFileSize + + :type: SIZE64 + :default: 1000000000 + + .. include:: /config-directive-description/sd-device-MaximumFileSize.rst.inc + + + +.. config:option:: sd/device/MaximumJobSpoolSize + + :type: SIZE64 + + .. include:: /config-directive-description/sd-device-MaximumJobSpoolSize.rst.inc + + + +.. config:option:: sd/device/MaximumNetworkBufferSize + + :type: PINT32 + + .. include:: /config-directive-description/sd-device-MaximumNetworkBufferSize.rst.inc + + + +.. config:option:: sd/device/MaximumOpenVolumes + + :type: PINT32 + :default: 1 + + .. include:: /config-directive-description/sd-device-MaximumOpenVolumes.rst.inc + + + +.. config:option:: sd/device/MaximumOpenWait + + :type: TIME + :default: 300 + + .. include:: /config-directive-description/sd-device-MaximumOpenWait.rst.inc + + + +.. config:option:: sd/device/MaximumPartSize + + :type: SIZE64 + :version: deprecated + + .. include:: /config-directive-description/sd-device-MaximumPartSize.rst.inc + + + +.. config:option:: sd/device/MaximumRewindWait + + :type: TIME + :default: 300 + + .. include:: /config-directive-description/sd-device-MaximumRewindWait.rst.inc + + + +.. config:option:: sd/device/MaximumSpoolSize + + :type: SIZE64 + + .. include:: /config-directive-description/sd-device-MaximumSpoolSize.rst.inc + + + +.. config:option:: sd/device/MaximumVolumeSize + + :type: SIZE64 + :version: deprecated + + .. include:: /config-directive-description/sd-device-MaximumVolumeSize.rst.inc + + + +.. config:option:: sd/device/MediaType + + :required: True + :type: STRNAME + + .. include:: /config-directive-description/sd-device-MediaType.rst.inc + + + +.. config:option:: sd/device/MinimumBlockSize + + :type: PINT32 + + .. include:: /config-directive-description/sd-device-MinimumBlockSize.rst.inc + + + +.. config:option:: sd/device/MountCommand + + :type: STRNAME + + .. include:: /config-directive-description/sd-device-MountCommand.rst.inc + + + +.. config:option:: sd/device/MountPoint + + :type: STRNAME + + .. include:: /config-directive-description/sd-device-MountPoint.rst.inc + + + +.. config:option:: sd/device/Name + + :required: True + :type: NAME + + Unique identifier of the resource. + + .. include:: /config-directive-description/sd-device-Name.rst.inc + + + +.. config:option:: sd/device/NoRewindOnClose + + :type: BOOLEAN + :default: yes + + .. include:: /config-directive-description/sd-device-NoRewindOnClose.rst.inc + + + +.. config:option:: sd/device/OfflineOnUnmount + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-OfflineOnUnmount.rst.inc + + + +.. config:option:: sd/device/QueryCryptoStatus + + :type: BOOLEAN + + .. include:: /config-directive-description/sd-device-QueryCryptoStatus.rst.inc + + + +.. config:option:: sd/device/RandomAccess + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-RandomAccess.rst.inc + + + +.. config:option:: sd/device/RemovableMedia + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-RemovableMedia.rst.inc + + + +.. config:option:: sd/device/RequiresMount + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-RequiresMount.rst.inc + + + +.. config:option:: sd/device/SpoolDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/sd-device-SpoolDirectory.rst.inc + + + +.. config:option:: sd/device/TwoEof + + :type: BIT + :default: no + + .. include:: /config-directive-description/sd-device-TwoEof.rst.inc + + + +.. config:option:: sd/device/UnmountCommand + + :type: STRNAME + + .. include:: /config-directive-description/sd-device-UnmountCommand.rst.inc + + + +.. config:option:: sd/device/UseMtiocget + + :type: BIT + :default: yes + + .. include:: /config-directive-description/sd-device-UseMtiocget.rst.inc + + + +.. config:option:: sd/device/VolumeCapacity + + :type: SIZE64 + + .. include:: /config-directive-description/sd-device-VolumeCapacity.rst.inc + + + +.. config:option:: sd/device/VolumePollInterval + + :type: TIME + :default: 300 + + .. include:: /config-directive-description/sd-device-VolumePollInterval.rst.inc + + + +.. config:option:: sd/device/WritePartCommand + + :type: STRNAME + :version: deprecated + + .. include:: /config-directive-description/sd-device-WritePartCommand.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-director-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-director-description.rst.inc new file mode 100644 index 00000000000..5a5bc99448d --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-director-description.rst.inc @@ -0,0 +1,174 @@ +.. config:option:: sd/director/Description + + :type: STRING + + .. include:: /config-directive-description/sd-director-Description.rst.inc + + + +.. config:option:: sd/director/KeyEncryptionKey + + :type: AUTOPASSWORD + + .. include:: /config-directive-description/sd-director-KeyEncryptionKey.rst.inc + + + +.. config:option:: sd/director/MaximumBandwidthPerJob + + :type: SPEED + + .. include:: /config-directive-description/sd-director-MaximumBandwidthPerJob.rst.inc + + + +.. config:option:: sd/director/Monitor + + :type: BOOLEAN + + .. include:: /config-directive-description/sd-director-Monitor.rst.inc + + + +.. config:option:: sd/director/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/sd-director-Name.rst.inc + + + +.. config:option:: sd/director/Password + + :required: True + :type: AUTOPASSWORD + + .. include:: /config-directive-description/sd-director-Password.rst.inc + + + +.. config:option:: sd/director/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/sd-director-TlsAllowedCn.rst.inc + + + +.. config:option:: sd/director/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/sd-director-TlsAuthenticate.rst.inc + + + +.. config:option:: sd/director/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/sd-director-TlsCaCertificateDir.rst.inc + + + +.. config:option:: sd/director/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/sd-director-TlsCaCertificateFile.rst.inc + + + +.. config:option:: sd/director/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/sd-director-TlsCertificate.rst.inc + + + +.. config:option:: sd/director/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/sd-director-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: sd/director/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/sd-director-TlsCipherList.rst.inc + + + +.. config:option:: sd/director/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/sd-director-TlsDhFile.rst.inc + + + +.. config:option:: sd/director/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/sd-director-TlsEnable.rst.inc + + + +.. config:option:: sd/director/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/sd-director-TlsKey.rst.inc + + + +.. config:option:: sd/director/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/sd-director-TlsRequire.rst.inc + + + +.. config:option:: sd/director/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/sd-director-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-messages-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-messages-description.rst.inc new file mode 100644 index 00000000000..6416a51c99f --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-messages-description.rst.inc @@ -0,0 +1,136 @@ +.. config:option:: sd/messages/Append + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Append.rst.inc + + + +.. config:option:: sd/messages/Catalog + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Catalog.rst.inc + + + +.. config:option:: sd/messages/Console + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Console.rst.inc + + + +.. config:option:: sd/messages/Description + + :type: STRING + + .. include:: /config-directive-description/sd-messages-Description.rst.inc + + + +.. config:option:: sd/messages/Director + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Director.rst.inc + + + +.. config:option:: sd/messages/File + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-File.rst.inc + + + +.. config:option:: sd/messages/Mail + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Mail.rst.inc + + + +.. config:option:: sd/messages/MailCommand + + :type: STRING + + .. include:: /config-directive-description/sd-messages-MailCommand.rst.inc + + + +.. config:option:: sd/messages/MailOnError + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-MailOnError.rst.inc + + + +.. config:option:: sd/messages/MailOnSuccess + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-MailOnSuccess.rst.inc + + + +.. config:option:: sd/messages/Name + + :type: NAME + + .. include:: /config-directive-description/sd-messages-Name.rst.inc + + + +.. config:option:: sd/messages/Operator + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Operator.rst.inc + + + +.. config:option:: sd/messages/OperatorCommand + + :type: STRING + + .. include:: /config-directive-description/sd-messages-OperatorCommand.rst.inc + + + +.. config:option:: sd/messages/Stderr + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Stderr.rst.inc + + + +.. config:option:: sd/messages/Stdout + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Stdout.rst.inc + + + +.. config:option:: sd/messages/Syslog + + :type: MESSAGES + + .. include:: /config-directive-description/sd-messages-Syslog.rst.inc + + + +.. config:option:: sd/messages/TimestampFormat + + :type: STRING + + .. include:: /config-directive-description/sd-messages-TimestampFormat.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-ndmp-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-ndmp-description.rst.inc new file mode 100644 index 00000000000..62e111c2d92 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-ndmp-description.rst.inc @@ -0,0 +1,53 @@ +.. config:option:: sd/ndmp/AuthType + + :type: AUTH_TYPE + :default: None + + .. include:: /config-directive-description/sd-ndmp-AuthType.rst.inc + + + +.. config:option:: sd/ndmp/Description + + :type: STRING + + .. include:: /config-directive-description/sd-ndmp-Description.rst.inc + + + +.. config:option:: sd/ndmp/LogLevel + + :type: PINT32 + :default: 4 + + .. include:: /config-directive-description/sd-ndmp-LogLevel.rst.inc + + + +.. config:option:: sd/ndmp/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/sd-ndmp-Name.rst.inc + + + +.. config:option:: sd/ndmp/Password + + :required: True + :type: AUTOPASSWORD + + .. include:: /config-directive-description/sd-ndmp-Password.rst.inc + + + +.. config:option:: sd/ndmp/Username + + :required: True + :type: STRING + + .. include:: /config-directive-description/sd-ndmp-Username.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-storage-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-storage-description.rst.inc new file mode 100644 index 00000000000..bd2c67094d1 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-sd-resource-storage-description.rst.inc @@ -0,0 +1,478 @@ +.. config:option:: sd/storage/AbsoluteJobTimeout + + :type: PINT32 + + .. include:: /config-directive-description/sd-storage-AbsoluteJobTimeout.rst.inc + + + +.. config:option:: sd/storage/AllowBandwidthBursting + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-AllowBandwidthBursting.rst.inc + + + +.. config:option:: sd/storage/AutoXFlateOnReplication + + :type: BOOLEAN + :default: no + :version: 13.4.0 + + .. include:: /config-directive-description/sd-storage-AutoXFlateOnReplication.rst.inc + + + +.. config:option:: sd/storage/BackendDirectory + + :type: DIRECTORY_LIST + :default: /usr/local/lib64/bareos/backends *(platform specific)* + + .. include:: /config-directive-description/sd-storage-BackendDirectory.rst.inc + + + +.. config:option:: sd/storage/ClientConnectWait + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/sd-storage-ClientConnectWait.rst.inc + + + +.. config:option:: sd/storage/CollectDeviceStatistics + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-CollectDeviceStatistics.rst.inc + + + +.. config:option:: sd/storage/CollectJobStatistics + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-CollectJobStatistics.rst.inc + + + +.. config:option:: sd/storage/Compatible + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-Compatible.rst.inc + + + +.. config:option:: sd/storage/Description + + :type: STRING + + .. include:: /config-directive-description/sd-storage-Description.rst.inc + + + +.. config:option:: sd/storage/DeviceReserveByMediaType + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-DeviceReserveByMediaType.rst.inc + + + +.. config:option:: sd/storage/FdConnectTimeout + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/sd-storage-FdConnectTimeout.rst.inc + + + +.. config:option:: sd/storage/FileDeviceConcurrentRead + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-FileDeviceConcurrentRead.rst.inc + + + +.. config:option:: sd/storage/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/sd-storage-HeartbeatInterval.rst.inc + + + +.. config:option:: sd/storage/LogTimestampFormat + + :type: STRING + :version: 15.2.3 + + .. include:: /config-directive-description/sd-storage-LogTimestampFormat.rst.inc + + + +.. config:option:: sd/storage/MaximumBandwidthPerJob + + :type: SPEED + + .. include:: /config-directive-description/sd-storage-MaximumBandwidthPerJob.rst.inc + + + +.. config:option:: sd/storage/MaximumConcurrentJobs + + :type: PINT32 + :default: 20 + + .. include:: /config-directive-description/sd-storage-MaximumConcurrentJobs.rst.inc + + + +.. config:option:: sd/storage/MaximumConnections + + :type: PINT32 + :default: 42 + :version: 15.2.3 + + .. include:: /config-directive-description/sd-storage-MaximumConnections.rst.inc + + + +.. config:option:: sd/storage/MaximumNetworkBufferSize + + :type: PINT32 + + .. include:: /config-directive-description/sd-storage-MaximumNetworkBufferSize.rst.inc + + + +.. config:option:: sd/storage/Messages + + :type: RES + + .. include:: /config-directive-description/sd-storage-Messages.rst.inc + + + +.. config:option:: sd/storage/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/sd-storage-Name.rst.inc + + + +.. config:option:: sd/storage/NdmpAddress + + :type: ADDRESS + :default: 10000 + + .. include:: /config-directive-description/sd-storage-NdmpAddress.rst.inc + + + +.. config:option:: sd/storage/NdmpAddresses + + :type: ADDRESSES + :default: 10000 + + .. include:: /config-directive-description/sd-storage-NdmpAddresses.rst.inc + + + +.. config:option:: sd/storage/NdmpEnable + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-NdmpEnable.rst.inc + + + +.. config:option:: sd/storage/NdmpLogLevel + + :type: PINT32 + :default: 4 + + .. include:: /config-directive-description/sd-storage-NdmpLogLevel.rst.inc + + + +.. config:option:: sd/storage/NdmpPort + + :type: PORT + :default: 10000 + + .. include:: /config-directive-description/sd-storage-NdmpPort.rst.inc + + + +.. config:option:: sd/storage/NdmpSnooping + + :type: BOOLEAN + :default: no + + .. include:: /config-directive-description/sd-storage-NdmpSnooping.rst.inc + + + +.. config:option:: sd/storage/PidDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/sd-storage-PidDirectory.rst.inc + + + +.. config:option:: sd/storage/PluginDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/sd-storage-PluginDirectory.rst.inc + + + +.. config:option:: sd/storage/PluginNames + + :type: PLUGIN_NAMES + + .. include:: /config-directive-description/sd-storage-PluginNames.rst.inc + + + +.. config:option:: sd/storage/ScriptsDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/sd-storage-ScriptsDirectory.rst.inc + + + +.. config:option:: sd/storage/SdAddress + + :type: ADDRESS + :default: 9103 + + .. include:: /config-directive-description/sd-storage-SdAddress.rst.inc + + + +.. config:option:: sd/storage/SdAddresses + + :type: ADDRESSES + :default: 9103 + + .. include:: /config-directive-description/sd-storage-SdAddresses.rst.inc + + + +.. config:option:: sd/storage/SdConnectTimeout + + :type: TIME + :default: 1800 + + .. include:: /config-directive-description/sd-storage-SdConnectTimeout.rst.inc + + + +.. config:option:: sd/storage/SdPort + + :type: PORT + :default: 9103 + + .. include:: /config-directive-description/sd-storage-SdPort.rst.inc + + + +.. config:option:: sd/storage/SdSourceAddress + + :type: ADDRESS + :default: 0 + + .. include:: /config-directive-description/sd-storage-SdSourceAddress.rst.inc + + + +.. config:option:: sd/storage/SecureEraseCommand + + :type: STRING + :version: 15.2.1 + + Specify command that will be called when bareos unlinks files. + + .. include:: /config-directive-description/sd-storage-SecureEraseCommand.rst.inc + + + +.. config:option:: sd/storage/StatisticsCollectInterval + + :type: PINT32 + :default: 30 + + .. include:: /config-directive-description/sd-storage-StatisticsCollectInterval.rst.inc + + + +.. config:option:: sd/storage/SubSysDirectory + + :type: DIRECTORY + + .. include:: /config-directive-description/sd-storage-SubSysDirectory.rst.inc + + + +.. config:option:: sd/storage/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/sd-storage-TlsAllowedCn.rst.inc + + + +.. config:option:: sd/storage/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/sd-storage-TlsAuthenticate.rst.inc + + + +.. config:option:: sd/storage/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/sd-storage-TlsCaCertificateDir.rst.inc + + + +.. config:option:: sd/storage/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/sd-storage-TlsCaCertificateFile.rst.inc + + + +.. config:option:: sd/storage/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/sd-storage-TlsCertificate.rst.inc + + + +.. config:option:: sd/storage/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/sd-storage-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: sd/storage/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/sd-storage-TlsCipherList.rst.inc + + + +.. config:option:: sd/storage/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/sd-storage-TlsDhFile.rst.inc + + + +.. config:option:: sd/storage/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/sd-storage-TlsEnable.rst.inc + + + +.. config:option:: sd/storage/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/sd-storage-TlsKey.rst.inc + + + +.. config:option:: sd/storage/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/sd-storage-TlsRequire.rst.inc + + + +.. config:option:: sd/storage/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/sd-storage-TlsVerifyPeer.rst.inc + + + +.. config:option:: sd/storage/VerId + + :type: STRING + + .. include:: /config-directive-description/sd-storage-VerId.rst.inc + + + +.. config:option:: sd/storage/WorkingDirectory + + :type: DIRECTORY + :default: /var/lib/bareos *(platform specific)* + + .. include:: /config-directive-description/sd-storage-WorkingDirectory.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-client-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-client-description.rst.inc new file mode 100644 index 00000000000..7aed852ce08 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-client-description.rst.inc @@ -0,0 +1,168 @@ +.. config:option:: console/client/Address + + :required: True + :type: STRING + + .. include:: /config-directive-description/console-client-Address.rst.inc + + + +.. config:option:: console/client/Description + + :type: STRING + + .. include:: /config-directive-description/console-client-Description.rst.inc + + + +.. config:option:: console/client/FdPort + + :type: PINT32 + :default: 9102 + + .. include:: /config-directive-description/console-client-FdPort.rst.inc + + + +.. config:option:: console/client/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/console-client-Name.rst.inc + + + +.. config:option:: console/client/Password + + :required: True + :type: MD5PASSWORD + + .. include:: /config-directive-description/console-client-Password.rst.inc + + + +.. config:option:: console/client/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/console-client-TlsAllowedCn.rst.inc + + + +.. config:option:: console/client/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/console-client-TlsAuthenticate.rst.inc + + + +.. config:option:: console/client/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/console-client-TlsCaCertificateDir.rst.inc + + + +.. config:option:: console/client/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/console-client-TlsCaCertificateFile.rst.inc + + + +.. config:option:: console/client/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/console-client-TlsCertificate.rst.inc + + + +.. config:option:: console/client/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/console-client-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: console/client/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/console-client-TlsCipherList.rst.inc + + + +.. config:option:: console/client/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/console-client-TlsDhFile.rst.inc + + + +.. config:option:: console/client/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/console-client-TlsEnable.rst.inc + + + +.. config:option:: console/client/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/console-client-TlsKey.rst.inc + + + +.. config:option:: console/client/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/console-client-TlsRequire.rst.inc + + + +.. config:option:: console/client/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/console-client-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-consolefont-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-consolefont-description.rst.inc new file mode 100644 index 00000000000..7a0ae53bb37 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-consolefont-description.rst.inc @@ -0,0 +1,25 @@ +.. config:option:: console/consolefont/Description + + :type: STRING + + .. include:: /config-directive-description/console-consolefont-Description.rst.inc + + + +.. config:option:: console/consolefont/Font + + :type: STRING + + .. include:: /config-directive-description/console-consolefont-Font.rst.inc + + + +.. config:option:: console/consolefont/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/console-consolefont-Name.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-director-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-director-description.rst.inc new file mode 100644 index 00000000000..3f7285f3efc --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-director-description.rst.inc @@ -0,0 +1,159 @@ +.. config:option:: console/director/Address + + :required: True + :type: STRING + + .. include:: /config-directive-description/console-director-Address.rst.inc + + + +.. config:option:: console/director/Description + + :type: STRING + + .. include:: /config-directive-description/console-director-Description.rst.inc + + + +.. config:option:: console/director/DirPort + + :type: PINT32 + :default: 9101 + + .. include:: /config-directive-description/console-director-DirPort.rst.inc + + + +.. config:option:: console/director/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/console-director-Name.rst.inc + + + +.. config:option:: console/director/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/console-director-TlsAllowedCn.rst.inc + + + +.. config:option:: console/director/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/console-director-TlsAuthenticate.rst.inc + + + +.. config:option:: console/director/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/console-director-TlsCaCertificateDir.rst.inc + + + +.. config:option:: console/director/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/console-director-TlsCaCertificateFile.rst.inc + + + +.. config:option:: console/director/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/console-director-TlsCertificate.rst.inc + + + +.. config:option:: console/director/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/console-director-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: console/director/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/console-director-TlsCipherList.rst.inc + + + +.. config:option:: console/director/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/console-director-TlsDhFile.rst.inc + + + +.. config:option:: console/director/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/console-director-TlsEnable.rst.inc + + + +.. config:option:: console/director/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/console-director-TlsKey.rst.inc + + + +.. config:option:: console/director/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/console-director-TlsRequire.rst.inc + + + +.. config:option:: console/director/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/console-director-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-monitor-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-monitor-description.rst.inc new file mode 100644 index 00000000000..9f4b9d3abbf --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-monitor-description.rst.inc @@ -0,0 +1,186 @@ +.. config:option:: console/monitor/Description + + :type: STRING + + .. include:: /config-directive-description/console-monitor-Description.rst.inc + + + +.. config:option:: console/monitor/DirConnectTimeout + + :type: TIME + :default: 10 + + .. include:: /config-directive-description/console-monitor-DirConnectTimeout.rst.inc + + + +.. config:option:: console/monitor/FdConnectTimeout + + :type: TIME + :default: 10 + + .. include:: /config-directive-description/console-monitor-FdConnectTimeout.rst.inc + + + +.. config:option:: console/monitor/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/console-monitor-Name.rst.inc + + + +.. config:option:: console/monitor/Password + + :required: True + :type: MD5PASSWORD + + .. include:: /config-directive-description/console-monitor-Password.rst.inc + + + +.. config:option:: console/monitor/RefreshInterval + + :type: TIME + :default: 60 + + .. include:: /config-directive-description/console-monitor-RefreshInterval.rst.inc + + + +.. config:option:: console/monitor/SdConnectTimeout + + :type: TIME + :default: 10 + + .. include:: /config-directive-description/console-monitor-SdConnectTimeout.rst.inc + + + +.. config:option:: console/monitor/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/console-monitor-TlsAllowedCn.rst.inc + + + +.. config:option:: console/monitor/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/console-monitor-TlsAuthenticate.rst.inc + + + +.. config:option:: console/monitor/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/console-monitor-TlsCaCertificateDir.rst.inc + + + +.. config:option:: console/monitor/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/console-monitor-TlsCaCertificateFile.rst.inc + + + +.. config:option:: console/monitor/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/console-monitor-TlsCertificate.rst.inc + + + +.. config:option:: console/monitor/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/console-monitor-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: console/monitor/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/console-monitor-TlsCipherList.rst.inc + + + +.. config:option:: console/monitor/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/console-monitor-TlsDhFile.rst.inc + + + +.. config:option:: console/monitor/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/console-monitor-TlsEnable.rst.inc + + + +.. config:option:: console/monitor/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/console-monitor-TlsKey.rst.inc + + + +.. config:option:: console/monitor/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/console-monitor-TlsRequire.rst.inc + + + +.. config:option:: console/monitor/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/console-monitor-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-storage-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-storage-description.rst.inc new file mode 100644 index 00000000000..f8f3a81d450 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bareos-tray-monitor-resource-storage-description.rst.inc @@ -0,0 +1,184 @@ +.. config:option:: console/storage/Address + + :required: True + :type: STRING + + .. include:: /config-directive-description/console-storage-Address.rst.inc + + + +.. config:option:: console/storage/Description + + :type: STRING + + .. include:: /config-directive-description/console-storage-Description.rst.inc + + + +.. config:option:: console/storage/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/console-storage-Name.rst.inc + + + +.. config:option:: console/storage/Password + + :required: True + :type: MD5PASSWORD + + .. include:: /config-directive-description/console-storage-Password.rst.inc + + + +.. config:option:: console/storage/SdAddress + + :type: STRING + + .. include:: /config-directive-description/console-storage-SdAddress.rst.inc + + + +.. config:option:: console/storage/SdPassword + + :type: MD5PASSWORD + + .. include:: /config-directive-description/console-storage-SdPassword.rst.inc + + + +.. config:option:: console/storage/SdPort + + :type: PINT32 + :default: 9103 + + .. include:: /config-directive-description/console-storage-SdPort.rst.inc + + + +.. config:option:: console/storage/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/console-storage-TlsAllowedCn.rst.inc + + + +.. config:option:: console/storage/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/console-storage-TlsAuthenticate.rst.inc + + + +.. config:option:: console/storage/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/console-storage-TlsCaCertificateDir.rst.inc + + + +.. config:option:: console/storage/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/console-storage-TlsCaCertificateFile.rst.inc + + + +.. config:option:: console/storage/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/console-storage-TlsCertificate.rst.inc + + + +.. config:option:: console/storage/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/console-storage-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: console/storage/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/console-storage-TlsCipherList.rst.inc + + + +.. config:option:: console/storage/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/console-storage-TlsDhFile.rst.inc + + + +.. config:option:: console/storage/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/console-storage-TlsEnable.rst.inc + + + +.. config:option:: console/storage/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/console-storage-TlsKey.rst.inc + + + +.. config:option:: console/storage/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/console-storage-TlsRequire.rst.inc + + + +.. config:option:: console/storage/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/console-storage-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bconsole-resource-console-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bconsole-resource-console-description.rst.inc new file mode 100644 index 00000000000..e6bac83eab4 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bconsole-resource-console-description.rst.inc @@ -0,0 +1,194 @@ +.. config:option:: console/console/Description + + :type: STRING + + .. include:: /config-directive-description/console-console-Description.rst.inc + + + +.. config:option:: console/console/Director + + :type: STRING + + .. include:: /config-directive-description/console-console-Director.rst.inc + + + +.. config:option:: console/console/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/console-console-HeartbeatInterval.rst.inc + + + +.. config:option:: console/console/HistoryFile + + :type: DIRECTORY + + .. include:: /config-directive-description/console-console-HistoryFile.rst.inc + + + +.. config:option:: console/console/HistoryLength + + :type: PINT32 + :default: 100 + + .. include:: /config-directive-description/console-console-HistoryLength.rst.inc + + + +.. config:option:: console/console/Name + + :required: True + :type: NAME + + The name of this resource. + + .. include:: /config-directive-description/console-console-Name.rst.inc + + + +.. config:option:: console/console/Password + + :required: True + :type: MD5PASSWORD + + .. include:: /config-directive-description/console-console-Password.rst.inc + + + +.. config:option:: console/console/RcFile + + :type: DIRECTORY + + .. include:: /config-directive-description/console-console-RcFile.rst.inc + + + +.. config:option:: console/console/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/console-console-TlsAllowedCn.rst.inc + + + +.. config:option:: console/console/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/console-console-TlsAuthenticate.rst.inc + + + +.. config:option:: console/console/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/console-console-TlsCaCertificateDir.rst.inc + + + +.. config:option:: console/console/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/console-console-TlsCaCertificateFile.rst.inc + + + +.. config:option:: console/console/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/console-console-TlsCertificate.rst.inc + + + +.. config:option:: console/console/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/console-console-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: console/console/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/console-console-TlsCipherList.rst.inc + + + +.. config:option:: console/console/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/console-console-TlsDhFile.rst.inc + + + +.. config:option:: console/console/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/console-console-TlsEnable.rst.inc + + + +.. config:option:: console/console/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/console-console-TlsKey.rst.inc + + + +.. config:option:: console/console/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/console-console-TlsRequire.rst.inc + + + +.. config:option:: console/console/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/console-console-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/autogenerated/bconsole-resource-director-description.rst.inc b/docs/manuals/en/new_main_reference/source/autogenerated/bconsole-resource-director-description.rst.inc new file mode 100644 index 00000000000..50a420bfe45 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/autogenerated/bconsole-resource-director-description.rst.inc @@ -0,0 +1,176 @@ +.. config:option:: console/director/Address + + :type: STRING + + .. include:: /config-directive-description/console-director-Address.rst.inc + + + +.. config:option:: console/director/Description + + :type: STRING + + .. include:: /config-directive-description/console-director-Description.rst.inc + + + +.. config:option:: console/director/DirPort + + :type: PINT32 + :default: 9101 + + .. include:: /config-directive-description/console-director-DirPort.rst.inc + + + +.. config:option:: console/director/HeartbeatInterval + + :type: TIME + :default: 0 + + .. include:: /config-directive-description/console-director-HeartbeatInterval.rst.inc + + + +.. config:option:: console/director/Name + + :required: True + :type: NAME + + .. include:: /config-directive-description/console-director-Name.rst.inc + + + +.. config:option:: console/director/Password + + :required: True + :type: MD5PASSWORD + + .. include:: /config-directive-description/console-director-Password.rst.inc + + + +.. config:option:: console/director/TlsAllowedCn + + :type: STRING_LIST + + "Common Name"s (CNs) of the allowed peer certificates. + + .. include:: /config-directive-description/console-director-TlsAllowedCn.rst.inc + + + +.. config:option:: console/director/TlsAuthenticate + + :type: BOOLEAN + :default: no + + Use TLS only to authenticate, not for encryption. + + .. include:: /config-directive-description/console-director-TlsAuthenticate.rst.inc + + + +.. config:option:: console/director/TlsCaCertificateDir + + :type: DIRECTORY + + Path of a TLS CA certificate directory. + + .. include:: /config-directive-description/console-director-TlsCaCertificateDir.rst.inc + + + +.. config:option:: console/director/TlsCaCertificateFile + + :type: DIRECTORY + + Path of a PEM encoded TLS CA certificate(s) file. + + .. include:: /config-directive-description/console-director-TlsCaCertificateFile.rst.inc + + + +.. config:option:: console/director/TlsCertificate + + :type: DIRECTORY + + Path of a PEM encoded TLS certificate. + + .. include:: /config-directive-description/console-director-TlsCertificate.rst.inc + + + +.. config:option:: console/director/TlsCertificateRevocationList + + :type: DIRECTORY + + Path of a Certificate Revocation List file. + + .. include:: /config-directive-description/console-director-TlsCertificateRevocationList.rst.inc + + + +.. config:option:: console/director/TlsCipherList + + :type: DIRECTORY + + List of valid TLS Ciphers. + + .. include:: /config-directive-description/console-director-TlsCipherList.rst.inc + + + +.. config:option:: console/director/TlsDhFile + + :type: DIRECTORY + + Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. + + .. include:: /config-directive-description/console-director-TlsDhFile.rst.inc + + + +.. config:option:: console/director/TlsEnable + + :type: BOOLEAN + :default: yes + + Enable TLS support. + + .. include:: /config-directive-description/console-director-TlsEnable.rst.inc + + + +.. config:option:: console/director/TlsKey + + :type: DIRECTORY + + Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate". + + .. include:: /config-directive-description/console-director-TlsKey.rst.inc + + + +.. config:option:: console/director/TlsRequire + + :type: BOOLEAN + :default: no + + Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes". + + .. include:: /config-directive-description/console-director-TlsRequire.rst.inc + + + +.. config:option:: console/director/TlsVerifyPeer + + :type: BOOLEAN + :default: no + + If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list. + + .. include:: /config-directive-description/console-director-TlsVerifyPeer.rst.inc + + + diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirClientHardQuota1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirClientHardQuota1.conf new file mode 100644 index 00000000000..6817b1c6768 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirClientHardQuota1.conf @@ -0,0 +1 @@ +Fatal error: append.c:218 Quota Exceeded. Job Terminated. \ No newline at end of file diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod1.conf new file mode 100644 index 00000000000..79b2b13cb68 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod1.conf @@ -0,0 +1 @@ +Error: Softquota Exceeded, Grace Period starts now. \ No newline at end of file diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod2.conf b/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod2.conf new file mode 100644 index 00000000000..62ced6c8051 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod2.conf @@ -0,0 +1 @@ +Error: Softquota Exceeded, will be enforced after Grace Period expires. \ No newline at end of file diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod3.conf b/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod3.conf new file mode 100644 index 00000000000..62f525cb2dc --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirClientSoftQuotaGracePeriod3.conf @@ -0,0 +1,3 @@ +Warning: Softquota Exceeded and Grace Period expired. +Setting Burst Quota to 122880000 Bytes. +Fatal error: Soft Quota Exceeded / Grace Time expired. Job terminated. \ No newline at end of file diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirClientStrictQuotas1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirClientStrictQuotas1.conf new file mode 100644 index 00000000000..5c283c6ce0d --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirClientStrictQuotas1.conf @@ -0,0 +1 @@ +Softquota Exceeded, enforcing Burst Quota Limit. \ No newline at end of file diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirClientStrictQuotas2.conf b/docs/manuals/en/new_main_reference/source/include/config/DirClientStrictQuotas2.conf new file mode 100644 index 00000000000..0aafde5a000 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirClientStrictQuotas2.conf @@ -0,0 +1 @@ +Softquota Exceeded, enforcing Strict Quota Limit. \ No newline at end of file diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirConsoleJobACL1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirConsoleJobACL1.conf new file mode 100644 index 00000000000..a055d2c51a9 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirConsoleJobACL1.conf @@ -0,0 +1,2 @@ +JobACL = "backup-bareos-fd", "backup-www.example.com-fd" +JobACL = "RestoreFiles" diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobRun1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobRun1.conf new file mode 100644 index 00000000000..16d733d6e03 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobRun1.conf @@ -0,0 +1,2 @@ +run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4" + diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobRunAfterFailedJob1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunAfterFailedJob1.conf new file mode 100644 index 00000000000..a6955401904 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunAfterFailedJob1.conf @@ -0,0 +1,8 @@ +Run Script { + Command = "echo test" + Runs When = After + Runs On Failure = yes + Runs On Client = no + Runs On Success = yes # default, you can drop this line +} + diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobRunBeforeJob1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunBeforeJob1.conf new file mode 100644 index 00000000000..9aa8a9fb5e3 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunBeforeJob1.conf @@ -0,0 +1,2 @@ +Run Before Job = "echo test" + diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobRunBeforeJob2.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunBeforeJob2.conf new file mode 100644 index 00000000000..5f7c4808ab6 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunBeforeJob2.conf @@ -0,0 +1,5 @@ +Run Script { + Command = "echo test" + Runs On Client = No + Runs When = Before +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript1.conf new file mode 100644 index 00000000000..db3d417adea --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript1.conf @@ -0,0 +1,2 @@ +Console = "prune files client=\%c" +Console = "update stats age=3" diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript2.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript2.conf new file mode 100644 index 00000000000..e1bf9dd07c0 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript2.conf @@ -0,0 +1,17 @@ +Run Script { + RunsWhen = Before + FailJobOnError = No + Command = "/etc/init.d/apache stop" +} + +RunScript { + RunsWhen = After + RunsOnFailure = Yes + Command = "/etc/init.d/apache start" +} + +RunScript { + RunsWhen = Before + FailJobOnError = Yes + Command = "sh -c 'top -b -n 1 > /var/backup/top.out'" +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript3.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript3.conf new file mode 100644 index 00000000000..eaad7c20f96 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobRunScript3.conf @@ -0,0 +1,5 @@ + Client Run Before Job = "systemstate" +or + Client Run Before Job = "systemstate.bat" +or + Client Run Before Job = "\"C:/Program Files/Bareos/systemstate.bat\"" diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobStripPrefix1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobStripPrefix1.conf new file mode 100644 index 00000000000..d7b4a588389 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobStripPrefix1.conf @@ -0,0 +1,2 @@ +Strip Prefix = c: +Add Prefix = d: diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirJobWriteBootstrap1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirJobWriteBootstrap1.conf new file mode 100644 index 00000000000..4d9d20391fe --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirJobWriteBootstrap1.conf @@ -0,0 +1,5 @@ +Job Defs { + ... + Write Bootstrap = "%c_%n.bsr" + ... +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirPoolActionOnPurge1.conf b/docs/manuals/en/new_main_reference/source/include/config/DirPoolActionOnPurge1.conf new file mode 100644 index 00000000000..e3808c4fecf --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirPoolActionOnPurge1.conf @@ -0,0 +1,5 @@ +Pool { + Name = Default + Action On Purge = Truncate + ... +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/DirPoolActionOnPurge2.conf b/docs/manuals/en/new_main_reference/source/include/config/DirPoolActionOnPurge2.conf new file mode 100644 index 00000000000..006f15e4566 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/DirPoolActionOnPurge2.conf @@ -0,0 +1,9 @@ +Job { + Name = BackupCatalog + ... + RunScript { + RunsWhen=After + RunsOnClient=No + Console = "purge volume action=truncate storage=File allpools" + } +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/FdClientAllowedJobCommand1.conf b/docs/manuals/en/new_main_reference/source/include/config/FdClientAllowedJobCommand1.conf new file mode 100644 index 00000000000..b0ab2556e64 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/FdClientAllowedJobCommand1.conf @@ -0,0 +1,6 @@ +Director { + Name = + Password = + Allowed Job Command = "backup" + Allowed Job Command = "runscript" +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/FdClientAllowedScriptDir1.conf b/docs/manuals/en/new_main_reference/source/include/config/FdClientAllowedScriptDir1.conf new file mode 100644 index 00000000000..7b40f24319a --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/FdClientAllowedScriptDir1.conf @@ -0,0 +1,18 @@ + +# bareos-fd.conf +Director { + Name = + Password = + Allowed Script Dir = "/etc/bareos" + Allowed Script Dir = "/path/that/is/also/allowed" +} + + + +# bareos-dir.conf +Job { + Name = "" + JobDefs = "DefaultJob" + Client Run Before Job = "/etc/bareos/runbeforejob.sh" # this will run + Client Run Before Job = "/tmp/runbeforejob.sh" # this will be blocked +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/FdClientFDAddresses1.conf b/docs/manuals/en/new_main_reference/source/include/config/FdClientFDAddresses1.conf new file mode 100644 index 00000000000..573c7f51e31 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/FdClientFDAddresses1.conf @@ -0,0 +1,20 @@ +FDAddresses = { + ip = { addr = 1.2.3.4; port = 1205; } + ipv4 = { + addr = 1.2.3.4; port = http; } + ipv6 = { + addr = 1.2.3.4; + port = 1205; + } + ip = { + addr = 1.2.3.4 + port = 1205 + } + ip = { addr = 1.2.3.4 } + ip = { + addr = 201:220:222::2 + } + ip = { + addr = bluedot.thun.net + } +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/FdClientPki.conf b/docs/manuals/en/new_main_reference/source/include/config/FdClientPki.conf new file mode 100644 index 00000000000..01108df15d0 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/FdClientPki.conf @@ -0,0 +1,10 @@ +FileDaemon { + Name = client1-fd + + # encryption configuration + PKI Signatures = Yes # Enable Data Signing + PKI Encryption = Yes # Enable Data Encryption + PKI Keypair = "/etc/bareos/client1-fd.pem" # Public and Private Keys + PKI Master Key = "/etc/bareos/master.cert" # ONLY the Public Key + PKI Cipher = aes128 # specify desired PKI Cipher here +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/MessagesMailCommand1.conf b/docs/manuals/en/new_main_reference/source/include/config/MessagesMailCommand1.conf new file mode 100644 index 00000000000..c19b443b7af --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/MessagesMailCommand1.conf @@ -0,0 +1 @@ +Mail Command = "/usr/sbin/bsmtp -h mail.example.com -f \"\(Bareos\) \%r\" -s \"Bareos: \%t \%e of \%c \%l\" \%r" diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceAlertCommand1.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceAlertCommand1.conf new file mode 100644 index 00000000000..16642777db9 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceAlertCommand1.conf @@ -0,0 +1 @@ +Alert Command = "sh -c 'tapeinfo -f %c | grep TapeAlert'" diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceAlertCommand2.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceAlertCommand2.conf new file mode 100644 index 00000000000..56f5a372fbd --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceAlertCommand2.conf @@ -0,0 +1,2 @@ +bareos-sd Alert: TapeAlert[32]: Interface: Problem with SCSI interface + between tape drive and initiator. diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceArchiveDevice1.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceArchiveDevice1.conf new file mode 100644 index 00000000000..b58b358fe0d --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceArchiveDevice1.conf @@ -0,0 +1,12 @@ +Device { + Name = FifoStorage + Media Type = Fifo + Device Type = Fifo + Archive Device = /tmp/fifo + LabelMedia = yes + Random Access = no + AutomaticMount = no + RemovableMedia = no + MaximumOpenWait = 60 + AlwaysOpen = no +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceChangerCommand1.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceChangerCommand1.conf new file mode 100644 index 00000000000..2325156ef43 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceChangerCommand1.conf @@ -0,0 +1 @@ +Changer Command = "/usr/lib/bareos/scripts/mtx-changer %c %o %S %a %d" diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceDeviceOptionsGfapi1.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceDeviceOptionsGfapi1.conf new file mode 100644 index 00000000000..0a04fbda1c3 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceDeviceOptionsGfapi1.conf @@ -0,0 +1,12 @@ +Device { + Name = GlusterStorage + Archive Device = "Gluster Device" + Device Options = "uri=gluster://server.example.com/volumename/bareos" + Device Type = gfapi + Media Type = GlusterFile + Label Media = yes + Random Access = yes + Automatic Mount = yes + Removable Media = no + Always Open = no +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceDeviceOptionsRados1.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceDeviceOptionsRados1.conf new file mode 100644 index 00000000000..24fe9a3638e --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceDeviceOptionsRados1.conf @@ -0,0 +1,12 @@ +Device { + Name = RadosStorage + Archive Device = "Rados Device" + Device Options = "conffile=/etc/ceph/ceph.conf,poolname=poolname" + Device Type = rados + Media Type = RadosFile + Label Media = yes + Random Access = yes + Automatic Mount = yes + Removable Media = no + Always Open = no +} diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceMinimumBlockSize1.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceMinimumBlockSize1.conf new file mode 100644 index 00000000000..4294ea261ca --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceMinimumBlockSize1.conf @@ -0,0 +1,2 @@ +Minimum block size = 100K +Maximum block size = 100K diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceMinimumBlockSize2.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceMinimumBlockSize2.conf new file mode 100644 index 00000000000..f6bde4cf351 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceMinimumBlockSize2.conf @@ -0,0 +1,2 @@ +Minimum block size = 63K +Maximum block size = 200K diff --git a/docs/manuals/en/new_main_reference/source/include/config/SdDeviceUnmountCommand1.conf b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceUnmountCommand1.conf new file mode 100644 index 00000000000..f14466b95de --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/include/config/SdDeviceUnmountCommand1.conf @@ -0,0 +1 @@ +Unmount Command = "/bin/umount %m"