> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/system-configuration.md).

# System configuration

Use these endpoints to view and configure the system itself: capacity and capacity policy, hardware (c.nodes, m.nodes, SSDs, disk groups), networking and static routes, LDAP and syslog servers, upgrades (NDU), expansion, and system state.

| Resource                                | Path                                             | Description                                                                                                                                      |
| --------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Secure remote support                   | `/proxy_secure_ssh`                              | Settings for the secure remote support connection that lets Silk Support access the system for troubleshooting and upgrades.                     |
| Static routes                           | `/static_routes`                                 | Static routes send traffic for a destination subnet through a specific gateway.                                                                  |
| System capacity                         | `/system/capacity`                               | The system's current capacity, including provisioned, allocated (logical), and physical capacity, and free and reserved space.                   |
| System capacity policy                  | `/system/capacity_policy`                        | The system-wide capacity policy, which sets the capacity thresholds at which the system reports warning, error, critical, and full states.       |
| Decommission                            | `/system/decommission`                           | Removes an m.node from the system.                                                                                                               |
| Disk groups                             | `/system/disk_groups`                            | The system's disk groups, including their RAID level and whether an expansion is in progress.                                                    |
| Expansion                               | `/system/expansion`                              | The status of system expansion operations, including the current stage and overall progress.                                                     |
| m.nodes (JBODs)                         | `/system/jbods`                                  | m.nodes (media nodes) provide the system's persistent capacity layer.                                                                            |
| LDAP servers                            | `/system/ldap_servers`                           | LDAP servers let users sign in with their directory credentials.                                                                                 |
| Local storage devices                   | `/system/local_storage_devs`                     | The system's local storage devices and their connectivity state.                                                                                 |
| Non-disruptive upgrade (NDU)            | `/system/ndu`                                    | The status of non-disruptive upgrades (NDUs), which update the system's software while it stays online.                                          |
| Network interfaces                      | `/system/net_interfaces`                         | The network interfaces on the system's c.nodes.                                                                                                  |
| Network IPs                             | `/system/net_ips`                                | The IP addresses assigned to the system's ports, and the service each one carries, such as iSCSI.                                                |
| Network ports                           | `/system/net_ports`                              | The system's IP data ports, including their link state and speed.                                                                                |
| Pairs                                   | `/system/pairs`                                  | The system's pairs, including their upgrade (NDU) state and whether an expansion is in progress.                                                 |
| System parameters                       | `/system/partial_system_parameters`              | System information and configuration limits, such as the maximum number of volumes and host LUNs, the maximum volume size, and network defaults. |
| SSD-to-c.node maps                      | `/system/server_jbod_connection_ssd_dev_maps`    | Maps each SSD device to the c.nodes connected to it.                                                                                             |
| c.node-to-m.node connections            | `/system/server_jbod_connections`                | The connections between c.nodes and m.nodes.                                                                                                     |
| c.node-to-canister connections          | `/system/server_jbod_expander_connections`       | The connections between c.nodes and m.node canisters.                                                                                            |
| c.nodes (servers)                       | `/system/servers`                                | c.nodes (compute nodes) provide the system's processing layer.                                                                                   |
| Snapshot capacity calculation           | `/system/snapshot_capacity_calculation`          | Calculates how much allocated capacity you'd free by removing selected snapshots and views.                                                      |
| Software states                         | `/system/software_states`                        | The system's software states, including the status and severity of HTTPS and SMTP connectivity.                                                  |
| SSD devices                             | `/system/ssd_devs`                               | The system's SSD devices, including their capacity and health.                                                                                   |
| System state                            | `/system/state`                                  | The system's current state and basic information, such as its name, software version, time zone, and iSCSI target name.                          |
| Static route iSCSI port mappings        | `/system/static_route_iscsi_port_mapper`         | Which iSCSI ports each static route uses.                                                                                                        |
| Static route network interface mappings | `/system/static_route_net_interface_port_mapper` | Which network interfaces each static route uses.                                                                                                 |
| Static route WAN port mappings          | `/system/static_route_wan_port_mapper`           | Which WAN ports each static route uses.                                                                                                          |
| Syslog servers                          | `/system/syslog_servers`                         | External syslog servers that receive the system's log messages and, optionally, its audit records.                                               |
| Target IQNs                             | `/system/target_iqns`                            | The system's iSCSI target IQNs, which hosts use to discover and connect to the system.                                                           |
| WAN connections                         | `/system/wan_connections`                        | The WAN connections between this system and its replication peers.                                                                               |
| Target authentication                   | `/target_auth`                                   | The credentials the system presents to hosts during mutual CHAP authentication, so each host can verify it's connecting to the right target.     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/system-configuration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
