...
Name (SNMP) | Default | Description and Examples |
|---|---|---|
bidding.relocationThreshold | 5 | Percentage, 0-100. How much difference between volume utilizations will cause a lower bid on another node to relocate or rebalance a replica to the other node. Lower values improve load balancing and throughput. Higher values minimize data movement at the expense of lower maximum throughput. |
cip.group | 224.0.10.100 | The multicast IP address for the cluster, as a Class D IP address in the 224.0.0.0 - 239.255.255.255 range. This address must be unique for each cluster. When configuring multiple, distinct clusters, take care that the multicast groups do not overlap, as any node with the same multicast group will become part of a single cluster. Set to blank to not use multicast. If this is done, the cluster.name must be unique within your network. |
cip.queryRetryMultiplier | 1 | What multiple of time to wait on each successive UDP multicast read retry. |
cip.ttl | 1 | Controls configuration of multicast network traffic TTL (time to live). When set to 1, the multicast traffic should remain on the subnet. |
cluster.enforceTenancy | false | Setting to True (recommended) ensures that all content is written into a domain named in the request or else into the default domain. Setting to False (default) allows backward compatibility for applications in use before Swarm 5.0 that access data outside of domains and is required when using Gateway in legacy only mode to access this kind of content. Set to True for new deployments. |
cluster.name |
| The name of the cluster. Use an IANA-compatible domain name, such as cluster.example.com, and create one domain with the same name as the cluster, which sets up a default cluster domain that holds all unnamed objects. Do not use spaces in the name. To prevent confusion, configure all nodes in the cluster with the same cluster name. |
cluster.proxyIPAddress |
| [deprecated] The reverse proxy IP address for the cluster. Use cluster.proxyIPList instead. |
cluster.proxyIPList |
| For use with bidirectional GET replication only, to configure proxies on the source side for the target nodes to connect to. A comma-separated list of reverse proxy IP addresses or names, including ports in name:port format. |
cluster.proxyPort | 80 | [deprecated] The reverse proxy access port for the cluster. Use cluster.proxyIPList instead. |
console.expiryErrInterval | 10 | Number of days before the cluster license expires to generate an error as a log message and a console indicator. |
console.expiryWarnInterval | 30 | Number of days before the cluster license expires to generate a warning as a log message and a console indicator. |
console.indexErrorLevel | 90 | Percentage, 0-100. How much index utilization will generate an error as a log message and a console indicator. |
console.indexWarningLevel | 80 | Percentage, 0-100. How much index utilization will generate a warning as a log message and a console indicator. |
console.messageExpirationSeconds | 1209600 | In seconds; defaults to 2 weeks. How long until an error expires out of the error table. |
console.port | 90 | Which port Swarm uses to listen for requests. All nodes in the same cluster must be set to the same port. When deploying Swarm into untrusted network environments, firewall this port so that only administrators can access it. |
console.reportStyleUrl |
| The URL for the path to the stylesheet and image files for configuring Swarm console. |
console.spaceErrorLevel | 10 | Percentage, 0-100. How much cluster capacity remaining will generate an error as a log message and a console indicator. |
console.spaceWarnLevel | 25 | Percentage, 0-100. How much cluster capacity remaining will generate a warning as a log message and a console indicator. |
console.styleUrl |
| The URL for the path to the stylesheet and image files for configuring the Swarm console. |
disk.atimeEnabled | false | Whether to track the time of last access on GET requests, stored in the Castor-System-Accessed header and indexed as the search field 'accessed'. Increases load on the cluster and Elasticsearch. |
disk.atimeGranularity | 86400 | In seconds; defaults to 1 day. The window during which accessed time will not be updated. Lowering the value affects GET performance. |
disk.contextDeleteMarkerLifespan | 31536000 | In seconds; defaults to 1 year. How long a delete marker lives for a context (domain or bucket) object. |
disk.deleteMarkerLifespan | 1209600 | In seconds; defaults to 2 weeks. How long the cluster remembers a deleted named object. |
disk.obsoleteTimeout | 1209600 | In seconds; defaults to 2 weeks. The amount of time after which an unused volume is considered "stale" and will not recover, except with use of the 'k' modifier. |
ec.conversionPercentage | 0 | Percentage, 1-100; 0 stops all conversion. Adjusts the rate at which the Health Processor consolidates multi-set erasure-coded objects each HP cycle. Lower to reduce cluster load; increase to convert a large number of eligible objects faster, at the cost of load on the cluster. Requires policy.eCEncoding to be specified. |
ec.convertToPolicy | false | When true, convert existing EC objects to whole replicas or to the EC encoding as specified by policy. |
ec.convertVersionedObjects | false | When true, Swarm performs lifepoint conversions and consolidations of multi-set erasure-coded versioned objects. |
ec.maxManifests | 6 | Range, 3-36. The maximum number of manifests written for an EC object. Usually p+1 are written for a k:p encoding. Do not set above 6 unless directed by Support. |
ec.minParity | -1 | Range -1 or 1-4; default of -1 is max(policyminreps - 1, 1), where policyminreps is the min value in policy.replicas. The minimum number of parity segments the cluster requires. This is the lower limit on p for EC content protection, regardless of the parity value expressed on individual objects through query arguments or lifepoints. |
ec.protectionLevel | node | Either 'node', 'subcluster', or 'volume'. At what level segments must be distributed for an EC write to succeed; note that multiple segments are allowed per level, if needed. 'node' (default) distributes segments across the cluster's physical/virtual machines. 'subcluster' requires node.subcluster to be defined across sets of nodes. You must have (k+p)/p nodes/subclusters for those levels; at minimum, you must have k+p volumes. |
ec.segmentConsolidationFrequency | 10 | Percentage, 1-100, 0 to disable. How quickly the health processor consolidates object segments after ingest. Increase this value (such as to 25, to consolidate over 4 HP cycles) to make new content readable sooner by clients. For multipart uploads via S3 clients, 10 is recommended; for SwarmFS, 100 is recommended, with extra space allowances for trapped space. Consolidation changes the ETag (which affects If-Match requests) and Castor-System-Version headers, but Content-MD5 and Castor-System-CompositeMD5 headers are unchanged. Therefore, have clients use hash and last-modified date, rather than ETag, to find if an object has changed. |
ec.segmentSize | -1 | In bytes; default of -1 implies 200 MB, with recommended minimum of 100 MB. The maximum size allowed for an EC segment before triggering another level of erasure coding. For mostly large (1+ GB) objects, increase to minimize the number of EC sets, which reduces index memory usage. Alternatively, increase the size as needed per write request using the 'segmentsize' query arg. |
feeds.pauseDisconnectPerHourLimit | 1000 | Pause a feed if the number of disconnections per hour exceeds this value. 0 disables. |
feeds.retry | [30, 300, 1200] | In seconds. The progressive number of retry attempts by the plug-in, when blocked. |
feeds.statsReportInterval | 300 | In seconds. How frequently to report statistics. |
health.defragInterval | 3600 | In seconds; defaults to 1 hour. How long to wait between attempts to defrag a volume during an HP cycle. |
health.ecrSegmentDelay | 0.0 | In seconds; defaults to 0.0. Tunes ECRs by defining the length of the forced delay after each segment is relocated. Change from default only as directed. |
health.examDelay | 0.19 | In seconds; defaults to 0.19. Tunes the health processor by defining the length of the forced delay until the next HP exam, or removes the delay altogether (-1). Change from default only as directed. |
health.fvrPushDelay | 0.7 | In seconds; defaults to 0.7. Tunes FVRs by defining the length of the forced delay after each replica/bundle is pushed to another node. Change from default only as directed. |
health.neonatalROWProtection | true | If the exam queue for newly written objects is close to overflow, enables Swarm to override the data protection scheme of transitioning to ROW (scsp.replicateOnWrite). All subsequent replicas are processed out of this queue. |
health.offloadPauseInterval | 600 | The delay between attempts to bulk offload to the cluster, in seconds. |
health.parallelWriteTimeout | 2592000 | In seconds; defaults to 1 month. When to time out an uncompleted multipart upload so that Swarm can clean up the unused parts. 0 disables; do not disable if using SwarmFS. |
health.persistentUnderreplicationAlertPercent | 2 | Percentage, 0-100; set 0 to disable. Creates an alert when this percentage (or more) of objects are persistently under-replicated. |
health.recursiveDeleteDelay | 604800 | In seconds; defaults to 1 week. The length of the grace period before the health processor begins reclaiming the space for a deleted domain or bucket. During this grace period, you can restore the domain or bucket without losing any of its content. No grace period is granted if you use recursive=now. |
health.relocationVolumeFillRate | 10 | Percentage, 0-100. How much available space on new volumes may be filled for object relocation during one cluster health processor (HP) cycle, to prevent the HP on existing nodes from overwhelming a new, empty node. |
health.replicationMulticastFrequency | 1 | Percentage, 0-100. The frequency, as an approximate percentage, that UUIDs are multicast to verify replicas. Set this parameter to the same value for all nodes in the cluster. |
health.replicationUnicastFrequency | 100 | Percentage, 0-100. The frequency, as an approximate percentage, that a unit is forced to verify hints. |
health.underreplicationAlertPercent | 10 | Percentage, 0-100; set 0 to disable. Generates an under-replication alert when the percentage of under-replicated objects exceeds this value. |
health.underreplicationTolerance | 100 | Count. The number of under-replicated objects below which to suppress the alerts triggered by health.underreplicationAlertPercent. |
index.optimize404 | true | Enables the Optimize 404 feature in the overlay index, which returns 404 without multicast where possible. |
index.ovMinNodes | 3 | Count. The minimum number of cluster nodes needed to activate use of the overlay index. |
index.overlayEnabled | true | Enables the overlay index. |
log.host |
| The IP address of the remote Syslog server. Logging must be used for production environments. Set to '' to stop logging in test environments. |
log.level | 30 | The log level, from most to least verbose, each including everything below it: 10, 20, 30, 40, 50, 0. 10 Debug (all information plus stack traces), 15 Audit (replication and object movement), 20 Info (informational, including non-errors), 30 Warn (user and application errors, plus SCSP 4xx/5xx codes), 40 Error (server hardware and software errors, plus abnormal conditions), 50 Critical (errors that can result in data loss, such as disk I/O errors), 0 Disable logging. |
log.obscureUUIDs | false | Whether to obscure UUIDs from displaying in INFO and higher level logs (does not affect AUDIT and lower levels). Set to True to abbreviate the UUID, if indicated by your security requirements. |
log.port | 514 | The port for the remote syslog host to use. |
metrics.diskUtilizationCheckInterval | 600 | [deprecated] In seconds, from 15 seconds to 1 day; defaults to 10 minutes. How frequently to check disk utilization on the Elasticsearch cluster. |
metrics.diskUtilizationThreshold | 5 | [deprecated] Percentage, 0-100. The minimum space available Elasticsearch disk space that, when reached, will stop metrics from being indexed. |
metrics.enableNodeExporter | true | Enabled by default. Set to FALSE to to disable the node_exporter service, for the export of both node system metrics and Swarm metrics. |
metrics.nodeExporterFrequency | 0 | In seconds, from 1 minute to 1 hour; How frequently to refresh Swarm-specific metrics via the node exporter. 0 disables export of this data. |
metrics.period | 900 | [deprecated] In seconds, from 15 seconds to 1 day; defaults to 15 minutes. How frequently to capture metrics-related statistics. |
metrics.port | 9200 | [deprecated] The port on the Elasticsearch server where metrics-related statistics are captured. |
metrics.target |
| [deprecated] One or more servers in the Elasticsearch cluster (fully qualified domain names or IP addresses) where metrics-related statistics are captured. Use spaces or commas to separate multiple values. To disable statistics collection, leave blank. |
network.dnsDomain |
| Optional. The domain name(s) that will be searched for host name resolution when using static IP assignment. Ignored unless network.ipAddress is set. Use in conjunction with network.dnsServers. |
network.dnsServers |
| Optional. The servers that will be used for host name resolution when using static IP assignment. Ignored unless network.ipAddress is set. Use in conjunction with network.dnsDomain. |
network.icmpAcceptRedirects | true | Determines if the node accepts routing information from ICMP redirect responses. |
network.igmpTimeout | 0 | In seconds; defaults to 0 (disabled). The IGMP querier timeout, which is the frequency that IGMP queries will be sent on the network. |
network.igmpVersion | 2 | Range, 1-3. The IGMP (Internet Group Management Protocol) version that the Linux kernel will use for host membership queries. |
network.mtu | 0 | In bytes. Sets the maximum transmission unit (MTU) that Swarm accepts. Set to a higher value to use jumbo frames. Before you change the default value, verify that the node's network interfaces and all other network hardware support the selected MTU; otherwise, the nodes might not be able to replicate objects or communicate. Set to 0 to use value from DHCP or else 1500. |
policy.eCEncoding | unspecified anchored | The cluster-wide setting for the EC (erasure coding) encoding policy. Valid values: unspecified, disabled, k:p (a tuple such as 5:2 that specifies the data (k) and parity (p) encoding to use). Add 'anchored' to set this cluster-wide; remove it to allow domains and buckets to have custom encodings. |
policy.eCMinStreamSize | 1Mb anchored | In integer units of megabytes (MB) or gigabytes (GB); must be 1MB or greater. The size that triggers an object to be erasure-coded, if specified (by eCEncoding, lifepoint, query arg) and allowed by policy. Below this threshold, objects are replicated unless they are multipart or chunked writes. Add 'anchored' to set this cluster-wide; remove it to allow domains and buckets to have custom values. |
policy.lifecycle | disabled | The cluster-wide setting for bucket lifecycle policies. If enabled, bucket lifecycle policies will be evaluated. |
policy.replicas | min:2 max:16 default:2 anchored | The minimum, maximum, and default number of replicas allowed for objects in this cluster. Can differ from the policy in a replicated target cluster. |
policy.versioning | disallowed | Specifies whether versioning is allowed to be enabled on contexts (domains and buckets) within the cluster. Valid states: disallowed, suspended, allowed. This policy overrides context-level policies. Disallowed removes historical versions, if any. Suspended stops creation of new versions but retains version history. |
power.savingMode | false | Enables Power Saving mode, which allows the system to go to sleep or power cap. Set to False to disable Power Saving mode. |
power.sleepAfter | 7200 | In seconds, 60 or greater; defaults to 2 hours. In Power Saving mode, how long a node is inactive before it becomes idle. |
power.wakeAfter | 28800 | In seconds; defaults to 8 hours. In Power Saving mode, how long a node is idle before it becomes active again. |
recovery.completedRecoveryExpiration | 2592000 | In seconds; defaults to 30 days. How long to remember completed recoveries. |
recovery.suspend | false | Defaults to False, which allows normal volume recovery and recovery behavior. Set to True to disable all recovery behavior. All nodes in the cluster must be set to the same value. |
recovery.suspendedVolumes | [] | The comma-separated list of 32-character volume IDs of the volumes for which recovery is suspended. |
recovery.volMaintenanceInterval | 10800 | In seconds; defaults to 3 hours. How long the cluster waits after a node has been rebooted or shut down before considering the node and its volumes missing for recovery and replication purposes. This time does not include the time to mount the volumes. This maintenance window allows administrators to perform regular, scheduled tasks on a node without creating over-replication in the cluster. Node shutdowns or failures that are not initiated by an administrator are considered immediately missing. |
scsp.allowPutCreate | false | When true, PUTs can be used to create new named objects. Conditional headers still apply. With this option enabled, you do not need to add the putcreate query argument. |
scsp.autoContentMD5Computation | false | When true, Swarm computes and stores the Content-MD5 value on every applicable write. |
scsp.autoRecursiveDelete | true | When true, all context deletes (deletes of domains and buckets) are treated as recursive, which prevents orphaned content. With this option enabled, you do not need to add the recursive query argument. To force immediate reclamation of space, use the recursive=now argument. |
scsp.autoSynchronousIndex | false | Whether to automatically attempt synchronous indexing on POST, PUT, APPEND, COPY and DELETE requests. |
scsp.autoSynchronousListingAction |
| Whether to automatically attempt synchronization on listing requests. Value 'wait' means to wait for scsp.synchronousListingWait, 'now' means to actively refresh the ES index, and '' means to not try to synchronize. |
scsp.clientPoolTimeout | 120 | In seconds. How long until pooled SCSP connections expire. |
scsp.defaultContextReplicas | -1 | Defaults to -1, which uses the value of scsp.maxContextReplicas. Sets the default number of replicas for a POST/PUT on a context (domain or bucket) object if the number is not specified by the current lifepoint or the request. |
scsp.defaultFeedSendTimeout | 30.0 | The timeout on a feed SEND request, if the timeout=true query argument is provided. |
scsp.defaultROWAction | immediate | The default Replicate On Write (ROW) action when scsp.replicateOnWrite is enabled. Valid options are 'immediate', 'full', or an integer between 2 and 5 (inclusive). |
scsp.defaultSynchronousIndexWait | 60.0 | The default length of time to wait for a synchronous indexing attempt on POST, PUT, APPEND, COPY and DELETE requests. |
scsp.domainHeaders | ['X-Forwarded-Host', 'Host'] | A comma-separated list of headers that specifies the search order in which to find the host of an SCSP request. RFC 7230 5.4 requires a Host header with every SCSP request to support web servers or server farms that host multiple domains. Your client might use an HTTP proxy that modifies the Host header, but the Swarm domain name matches the original Host header. In that case, an HTTP proxy copies the original Host header into another header, typically X-Forwarded-Host. |
scsp.enableVolumeRedirects | false | Whether to allow redirects to SCSP heads on volume processes, for faster GET requests. For use with Gateway only, and best for sites with smaller objects. |
scsp.falseStartTimeout | 240 | In seconds, 0 to disable; defaults to 4 minutes. How long to wait to receive the first byte before timing out and disconnecting. |
scsp.filterResponseBlacklist | [] | Which headers to remove from HTTP responses. List is comma-separated and case-insensitive. For example: ['Castor-System-Path', 'Castor-System-Owner'] |
scsp.filterResponseHeaders | none | Swarm will filter response headers according to the given method. Allowed values: 'none', 'blacklist', 'whitelist'. |
scsp.filterResponseWhitelist | [] | Which headers to retain in HTTP responses, removing all others. List is comma-separated and case-insensitive. For example: ['Etag', 'Last-Modified'] |
scsp.idleDisconnectTimeout | 14400 | In seconds, 0 to disable; defaults to 4 hours. How long to wait after receiving the last byte before timing out and disconnecting. |
scsp.keepAliveInterval | 15 | How many seconds to wait before sending successive chunked keep-alive bytes after a 202 Accepted response. |
scsp.maxContextReplicas | 16 | Count. Sets the maximum number of replicas in this cluster for a context (domain or bucket) object. |
scsp.maxReadTime | 10800 | SCSP read time limit in seconds; defaults to 3 hours. SCSP GET requests running longer than this value will be prematurely closed. |
scsp.maxWriteTime | 10800 | SCSP write time limit in seconds; defaults to 3 hours. SCSP write requests running longer than this value will be prematurely closed. |
scsp.port | 80 | Port number; defaults to 80. The port used by client applications to access cluster nodes with HTTP requests. This setting must be the same on all nodes in the same cluster. |
scsp.replicateOnWrite | true | Enabled by default. Improves content integrity by requiring a replica to be written in order for the POST, PUT, COPY, or APPEND request to succeed. Set to False to have the health processor manage creation of replicas after the write. |
scsp.requireExplicitContextCreate | false | When true, Swarm requires creation of a context (domain or bucket) to include the 'Content-type: application/castorcontext' header. Enable the option to protect against content being erroneously written as context objects, which hurts performance. |
scsp.synchronousListingWait | 1.0 | The length of time to wait for a list synchronization. |
scsp.validateOnRead | false | Disabled by default. Enable to force Swarm to validate the object's contents before returning successful read responses to client requests. Although validation can be specified on a per-read basis, this setting forces all reads to use validation. During the read from the disk, the content hash is computed. If the hash is wrong, indicating logical disk corruption, the socket will be closed before the last block is transmitted, forcing an error to the client. Note that using this option creates additional CPU load on the node. |
search.caseInsensitive | false | Whether metadata fields should support case-insensitive searching. If true, then all custom metadata will be indexed to support only case-insensitive searching. |
search.enableCustomMetadataTyping | false | Whether to publish custom metadata typing information to Elasticsearch. |
search.enableDelimiterPaths | true | Whether to publish name delimiter path information to Elasticsearch. |
search.numberOfShards | 512 | The number of shards to use when creating new Elasticsearch search indexes. |
search.pathDelimiter | / | Which character to use for parsing directory paths from object names, such as '2018/Q4/snapshot.pdf'. Defaults to forward slash: / |
security.administrators | {'admin': 'ourpwdofchoicehere'} | One or more username:password pairs. Sets credentials for who can administer the cluster via the Swarm UI. If the value includes the snmp username, remove it from here and update snmp.rwCommunity with its password. |
security.noauth | true | [deprecated] To enable native Swarm authorization, set to False. |
security.operators | {} | One or more username:password pairs. Sets credentials for who can view the Swarm UI. If the value includes an snmp username, it is ignored; remove it from here and update snmp.roCommunity with its password. |
security.secureLogging | false | Enable to prevent logging of the details of a client request. This option results in short, secure log messages. |
snmp.getnextskips | ['35', '36.20', '36.21', '36.22', '36.23', '36.25', '37.11.8', '38', '41', '55', '57', '58', '61', '63', '64', '65', '66', '68', '69'] | List of OIDs to be skipped on output. To protect cluster performance, this setting causes the snmpwalk of the entire CASTOR MIB to skip several large, detailed tables in SNMP groups. The default list of OIDs causes a top-level snmpwalk to skip the groups or tables under clusterConfig, responseHistogramTable, hp, clusterdata, indexer, configVariableTable, castorFeeds, feedVolTable, performance, and recoveryTable. You can add or remove OIDs to control which sections of the MIB are returned by an snmpwalk. Enter values as strings in numeric form, relative to the Castor OID, .1.3.6.1.4.1.24659.1. |
snmp.roCommunity | public | Password for the SNMP read-only community. If security.operators includes the snmp username, remove it and update the password here. |
snmp.rwCommunity | ourpwdofchoicehere | Password for the SNMP read-write community. If security.administrators includes the snmp username, remove it and update the password here. |
snmp.timeout | 5 | In seconds, 1-60. The snmpget, snmpset, and snmpwalk timeout for Swarm and Watchdog. |
startup.certificates |
| Public certificates to add to cert bundle. |
...