YumaPro YANG

https://github.com/yumaworks/yumapro-yang
Admin
YumaPro YANG is a collection of YANG modules for the YumaPro SDK that define configuration...
Tokens:10,266
Snippets:54
Trust Score:3.6
License:BSD-3-Clause
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start netconfd-pro with Production Settings

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Use this command to start the netconfd-pro server with essential production configurations. Ensure log files and directories are correctly set up.

```bash
netconfd-pro \
  --log=/var/log/netconfd-pro.log \
  --log-level=info \
  --audit-log=/var/log/netconfd-pro-audit.log \
  --access-control=enforcing \
  --superuser=admin \
  --home=/var/lib/netconfd-pro \
  --confdir=/etc/netconfd-pro/conf.d \
  --module=ietf-interfaces \
  --module=ietf-ip \
  --with-callhome=true \
  --callhome-server=nms.example.com \
  --fileloc-fhs=true \
  --tls-v1.3-only=true \
  --with-nmda=true \
  --with-factory-datastore=true \
  --with-yumaworks-compare=true
```

--------------------------------

### RESTCONF GET with depth and content query parameters

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Example of a RESTCONF GET request to retrieve configuration data for interfaces, limited to 'config' nodes and a depth of 2. Requires 'Accept: application/yang-data+json' header.

```http
# RESTCONF GET with depth and content query parameters
# Retrieve only config nodes, 2 levels deep
GET /restconf/data/ietf-interfaces:interfaces?content=config&depth=2
Accept: application/yang-data+json
Authorization: Basic YWRtaW46YWRtaW4=
```

```json
# Response (HTTP 200)
{
  "ietf-interfaces:interfaces": {
    "interface": [
      {
        "name": "eth0",
        "type": "iana-if-type:ethernetCsmacd",
        "enabled": true
      }
    ]
  }
}
```

--------------------------------

### netconfd-pro Configuration File Equivalent

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

This XML configuration file provides an equivalent setup for netconfd-pro as specified by the command-line arguments. It is useful for managing configuration declaratively.

```xml
<!-- Equivalent configuration file (netconfd-pro.conf) -->
<netconfd-pro xmlns="http://yumaworks.com/ns/netconfd-pro">
  <log>/var/log/netconfd-pro.log</log>
  <log-level>info</log-level>
  <audit-log>/var/log/netconfd-pro-audit.log</audit-log>
  <access-control>enforcing</access-control>
  <superuser>admin</superuser>
  <with-callhome>true</with-callhome>
  <callhome-server>nms.example.com</callhome-server>
  <with-nmda>true</with-nmda>
  <tls-v1.3-only>true</tls-v1.3-only>
  <with-factory-datastore>true</with-factory-datastore>
</netconfd-pro>
```

--------------------------------

### Get Server Version with yumaworks-system

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Retrieve the current server version and build date. The response contains 'version' and 'build-date' elements.

```xml
<rpc message-id="14" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-server-version xmlns="http://yumaworks.com/ns/yumaworks-system"/>
</rpc>
<rpc-reply message-id="14" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <version xmlns="http://yumaworks.com/ns/yumaworks-system">25.10-3</version>
  <build-date xmlns="http://yumaworks.com/ns/yumaworks-system">2025-11-24</build-date>
</rpc-reply>
```

--------------------------------

### NETCONF <get-config> with subtree filter

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Example of a NETCONF get-config RPC using a subtree filter to retrieve specific interface configuration. Requires the 'urn:ietf:params:xml:ns:netconf:base:1.0' namespace.

```xml
<rpc message-id="1" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-config>
    <source>
      <running/>
    </source>
    <filter type="subtree">
      <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"/>
    </filter>
  </get-config>
</rpc>
```

```xml
<!-- Response -->
<rpc-reply message-id="1" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <data>
    <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
      <interface>
        <name>eth0</name>
        <type xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type">
          ianaift:ethernetCsmacd
        </type>
        <enabled>true</enabled>
      </interface>
    </interfaces>
  </data>
</rpc-reply>
```

--------------------------------

### Subscribe to NETCONF Notifications with Replay

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Subscribe to NETCONF notifications, including historical events from a specified start time, using the `<create-subscription>` RPC. This allows for replaying past events.

```xml
<rpc message-id="51" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
    <stream>NETCONF</stream>
    <startTime>2025-01-01T00:00:00Z</startTime>
  </create-subscription>
</rpc>
```

--------------------------------

### RESTCONF GET with NMDA datastore and with-origin

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

RESTCONF GET request to access the operational datastore with the 'with-origin' parameter to include data origin information. Ensure the correct datastore and namespace are used.

```http
# RESTCONF GET with NMDA datastore and with-origin
GET /restconf/ds/ietf-datastores:operational/ietf-interfaces:interfaces?with-origin
Accept: application/yang-data+json
```

--------------------------------

### Enable/Disable Protocol with yumaworks-system

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Control the runtime status of network protocols. This example disables the 'restconf' protocol.

```xml
<rpc message-id="15" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <protocol-control xmlns="http://yumaworks.com/ns/yumaworks-system">
    <action>disable</action>
    <protocol>restconf</protocol>
  </protocol-control>
</rpc>
```

--------------------------------

### XPath-Filtered Bulk List Retrieval with yumaworks-getbulk

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Retrieve a subset of YANG list entries based on an XPath filter. This example fetches only enabled interfaces.

```xml
<rpc message-id="22" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <list-target>/ietf-interfaces:interfaces/interface</list-target>
    <count>10</count>
    <list-test>enabled = 'true'</list-test>
  </get-bulk>
</rpc>
```

--------------------------------

### Set Server Log Level with yumaworks-system

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Control the logging verbosity for specific streams. This example sets the 'audit' stream to 'debug2' level.

```xml
<rpc message-id="13" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <set-log-level xmlns="http://yumaworks.com/ns/yumaworks-system">
    <log-level>debug2</log-level>
    <log-stream>audit</log-stream>
  </set-log-level>
</rpc>
```

--------------------------------

### Get HA Status with yumaworks-system

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Query the high-availability status of the server. This RPC returns the current HA state.

```xml
<rpc message-id="16" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-ha-status xmlns="http://yumaworks.com/ns/yumaworks-system"/>
</rpc>
```

--------------------------------

### RESTCONF event streams retrieval

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

RESTCONF GET request to retrieve available event streams. Requires 'Accept: application/yang-data+json' header.

```http
# RESTCONF event streams
GET /restconf/streams
Accept: application/yang-data+json
```

--------------------------------

### RESTCONF YANG schema retrieval

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

RESTCONF GET request to retrieve YANG schema definitions for a specific module and revision. Requires 'Accept: application/yang' header.

```http
# RESTCONF YANG schema retrieval
GET /restconf/yang/ietf-interfaces@2018-02-20
Accept: application/yang
```

--------------------------------

### Configure Call Home Server Entry (NETCONF)

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Configure Call Home server entries using NETCONF `edit-config`. Entries are create/delete only and immutable after creation. Supports both NETCONF-SSH and NETCONF-TLS protocols.

```xml
<rpc message-id="40" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target><running/></target>
    <config>
      <callhome xmlns="http://yumaworks.com/ns/yumaworks-callhome">
        <server nc:operation="create"
          xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
          <name>nms-primary</name>
          <address>192.0.2.100</address>
          <port>4334</port>
          <protocol>netconf-ssh</protocol>
        </server>
        <server nc:operation="create"
          xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
          <name>nms-backup</name>
          <address>nms-backup.example.com</address>
          <protocol>netconf-tls</protocol>
        </server>
      </callhome>
    </config>
  </edit-config>
</rpc>
```

--------------------------------

### Backup Running Configuration with yumaworks-system

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Use this RPC to create a backup of the current server configuration. Specify the filename and whether to overwrite existing backups.

```xml
<rpc message-id="10" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <backup xmlns="http://yumaworks.com/ns/yumaworks-system">
    <filename>backup-2025-01</filename>
    <overwrite>false</overwrite>
  </backup>
</rpc>
```

--------------------------------

### Configure Event Filtering Rules (NETCONF)

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Enable the event filtering service and configure per-event rules using NETCONF `edit-config`. Specify module, event, and whether to enable or suppress events, along with logging behavior for dropped events.

```xml
<rpc message-id="50" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target><running/></target>
    <config>
      <event-filters xmlns="http://yumaworks.com/ns/yumaworks-event-filter">
        <!-- Enable link-up notifications for replay -->
        <event-filter>
          <module>ietf-interfaces</module>
          <event>link-up</event>
          <enabled>true</enabled>
          <log-drops>false</log-drops>
        </event-filter>
        <!-- Disable (suppress) link-down events -->
        <event-filter>
          <module>ietf-interfaces</module>
          <event>link-down</event>
          <enabled>false</enabled>
          <log-drops>true</log-drops>
        </event-filter>
      </event-filters>
    </config>
  </edit-config>
</rpc>
```

--------------------------------

### Bulk List Retrieval

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Provides the `<get-bulk>` RPC for paginated iteration over large YANG list instances. Supports datastore selection, depth limiting, XPath filtering, key-value constraints, and `with-defaults`. Returns a cursor (`last-keys`) for stateless pagination.

```APIDOC
## get-bulk

### Description
Retrieves a paginated list of entries from a YANG list instance.

### Method
POST

### Endpoint
/restconf/operations/yumaworks-getbulk:get-bulk

### Parameters
#### Request Body
- **list-target** (string) - Required - The XPath to the list instance (e.g., `/ietf-interfaces:interfaces/interface`).
- **count** (integer) - Required - The number of entries to retrieve per page.
- **content** (string) - Optional - Specifies the content to retrieve. Possible values include 'all'.
- **depth** (string) - Optional - Limits the depth of the data to retrieve. Possible values include 'unbounded'.
- **list-test** (string) - Optional - An XPath filter to apply to the list entries.
- **fixed-keys** (object) - Optional - Constraints for key-value pairs.
- **with-defaults** (string) - Optional - Specifies how to handle default values.
- **last-keys** (object) - Optional - Used for pagination, providing the keys of the last entry from the previous page.

### Request Example (First Page)
```xml
<rpc message-id="20" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <list-target>/ietf-interfaces:interfaces/interface</list-target>
    <count>3</count>
    <content>all</content>
    <depth>unbounded</depth>
  </get-bulk>
</rpc>
```

### Response
#### Success Response (200)
- **last-keys** (object) - Contains the keys of the last entry retrieved, used for subsequent pagination.
- **data** (object) - Contains the retrieved list data.

### Response Example
```xml
<rpc-reply message-id="20" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <last-keys><name>eth2</name></last-keys>
    <data>
      <interface><name>eth0</name><enabled>true</enabled></interface>
      <interface><name>eth1</name><enabled>true</enabled></interface>
      <interface><name>eth2</name><enabled>false</enabled></interface>
    </data>
  </bulk>
</rpc-reply>
```

### Request Example (Next Page)
```xml
<rpc message-id="21" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <list-target>/ietf-interfaces:interfaces/interface</list-target>
    <count>3</count>
    <last-keys><name>eth2</name></last-keys>
  </get-bulk>
</rpc>
```

### Request Example (XPath-filtered)
```xml
<rpc message-id="22" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <list-target>/ietf-interfaces:interfaces/interface</list-target>
    <count>10</count>
    <list-test>enabled = 'true'</list-test>
  </get-bulk>
</rpc>
```
```

--------------------------------

### Configure Call Home Server Entry (RESTCONF)

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Configure Call Home server entries using RESTCONF with JSON payload. This provides an alternative to NETCONF for managing Call Home connections.

```json
# POST /restconf/data/yumaworks-callhome:callhome/server
# Content-Type: application/yang-data+json
{
  "yumaworks-callhome:server": [
    {
      "name": "nms-primary",
      "address": "192.0.2.100",
      "port": 4334,
      "protocol": "netconf-ssh"
    }
  ]
}
```

--------------------------------

### Dynamically Load YANG Module with yumaworks-system

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

This RPC allows for the dynamic loading of YANG modules at runtime. Specify the module name and whether to save the configuration changes.

```xml
<rpc message-id="12" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <load xmlns="http://yumaworks.com/ns/yumaworks-system">
    <module>my-vendor-module</module>
    <save-config>true</save-config>
  </load>
</rpc>
<!-- Response includes revision date -->
<rpc-reply message-id="12" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <mod-revision xmlns="http://yumaworks.com/ns/yumaworks-system">
    2024-06-01
  </mod-revision>
</rpc-reply>
```

--------------------------------

### NETCONF <edit-config> using YumaPro delete-all operation

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Demonstrates a NETCONF edit-config RPC utilizing the YumaPro-specific 'delete-all' operation to remove all interfaces. Ensure the 'nc:operation' attribute is correctly namespaced.

```xml
<rpc message-id="2" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target><candidate/></target>
    <config>
      <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
        <interface nc:operation="delete-all"
          xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"/>
      </interfaces>
    </config>
  </edit-config>
</rpc>
```

--------------------------------

### YumaPro YANG Extensions for SIL Annotations

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

This YANG module demonstrates the use of yumaworks-extensions for SIL annotations. It shows how to define all-in-one GET2 callbacks, custom XPath functions, and sorting for lists.

```yang
// Using yumaworks-extensions in a SIL annotation file
module my-vendor-annot {
  yang-version 1.1;
  namespace "http://example.com/ns/my-vendor-annot";
  prefix "mva";

  import ietf-interfaces { prefix if; }
  import yumaworks-extensions { prefix ywx; }

  // Use all-in-one GET2 callback for interface stats
  deviation /if:interfaces-state/if:interface/if:statistics {
    deviate add {
      ywx:sil-aio-get2 "get_interface_stats";
    }
  }

  // Custom XPath function for SIL
  ywx:sil-xpath-function "my-custom-function" {
    ywx:errmsg "Custom function evaluation failed";
  }

  // Sort interface list by name
  deviation /if:interfaces/if:interface {
    deviate add {
      ywx:sort-type "system";
    }
  }
}
```

--------------------------------

### Using YumaPro Common Types in a YANG Module

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

This YANG module illustrates the usage of common YumaPro types like NcxName, NcDebugType, NcxFileName, transport-type, and access-control-mode. These types provide standardized data formats.

```yang
// Using YumaPro types in a custom module
module my-device-config {
  yang-version 1.1;
  namespace "http://example.com/ns/my-device-config";
  prefix "mdc";

  import yumaworks-types { prefix ywt; }
  import yuma-types      { prefix yt;  }

  container device {
    leaf name {
      // NcxName: [a-z,A-Z][a-z,A-Z,0-9,_,-,.]* up to 64 chars
      type yt:NcxName;
      mandatory true;
    }

    leaf log-level {
      // off | error | warn | info | debug | debug2 | debug3 | debug4
      type yt:NcDebugType;
      default "info";
    }

    leaf backup-file {
      // Simple filename with no path components
      type ywt:NcxFileName;
    }

    leaf transport {
      // netconf-ssh | netconf-tls | restconf-http | restconf-https | gnmi
      type ywt:transport-type;
    }

    leaf access-mode {
      // off | disabled | permissive | enforcing
      type ywt:access-control-mode;
      default "enforcing";
    }
  }
}
```

--------------------------------

### Lock All Datastores Atomically

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Use the `<lock-all>` RPC to atomically lock all configuration datastores. An `<ok/>` reply indicates success. An error reply, such as 'in-use', signifies that another session holds a lock.

```xml
<rpc message-id="30" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <lock-all xmlns="urn:ietf:params:xml:ns:yang:yumaworks-lock"/>
</rpc>
<rpc-reply message-id="30" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <ok/>
</rpc-reply>

<!-- Error: another session holds a lock -->
<rpc-reply message-id="30" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <rpc-error>
    <error-type>protocol</error-type>
    <error-tag>in-use</error-tag>
    <error-severity>error</error-severity>
    <error-message>candidate datastore is locked by session 42</error-message>
  </rpc-error>
</rpc-reply>
```

--------------------------------

### Restore Configuration with yumaworks-system

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Use this RPC to restore a previously saved configuration. Ensure the specified filename exists on the server.

```xml
<rpc message-id="11" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <restore xmlns="http://yumaworks.com/ns/yumaworks-system">
    <filename>backup-2025-01</filename>
  </restore>
</rpc>
```

--------------------------------

### RESTCONF Query Parameter Models

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Augments the IETF RESTCONF root with YumaPro-specific entry points and reusable groupings for standard RESTCONF query parameters.

```APIDOC
## RESTCONF GET with depth and content query parameters

### Description
Retrieves configuration data for interfaces, limited to 2 levels deep.

### Method
GET

### Endpoint
/restconf/data/ietf-interfaces:interfaces?content=config&depth=2

### Parameters
#### Query Parameters
- **content** (string) - Optional - Specifies the type of data to retrieve (e.g., 'config').
- **depth** (integer) - Optional - Specifies the maximum depth of the data to retrieve.

### Request Example
```http
GET /restconf/data/ietf-interfaces:interfaces?content=config&depth=2
Accept: application/yang-data+json
Authorization: Basic YWRtaW46YWRtaW4=
```

### Response
#### Success Response (200)
```json
{
  "ietf-interfaces:interfaces": {
    "interface": [
      {
        "name": "eth0",
        "type": "iana-if-type:ethernetCsmacd",
        "enabled": true
      }
    ]
  }
}
```

## RESTCONF GET with NMDA datastore and with-origin

### Description
Retrieves operational data for interfaces, including origin information for NMDA compliance.

### Method
GET

### Endpoint
/restconf/ds/ietf-datastores:operational/ietf-interfaces:interfaces?with-origin

### Parameters
#### Query Parameters
- **with-origin** (boolean) - Optional - If present, includes origin information.

### Response
#### Success Response (200)
(Response body not provided in source)

## RESTCONF event streams

### Description
Retrieves available event streams from the RESTCONF server.

### Method
GET

### Endpoint
/restconf/streams

### Response
#### Success Response (200)
(Response body not provided in source)

## RESTCONF YANG schema retrieval

### Description
Retrieves the YANG schema for a specified module and revision.

### Method
GET

### Endpoint
/restconf/yang/ietf-interfaces@2018-02-20

### Parameters
#### Path Parameters
- **module@revision** (string) - Required - The module name and revision (e.g., 'ietf-interfaces@2018-02-20').

### Response
#### Success Response (200)
(Response body not provided in source, expected to be YANG schema content)
```

--------------------------------

### First Page Bulk List Retrieval with yumaworks-getbulk

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Initiate a paginated retrieval of a YANG list. Specify the target list, desired count per page, content type, and depth. The response includes 'last-keys' for subsequent pagination.

```xml
<rpc message-id="20" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <list-target>/ietf-interfaces:interfaces/interface</list-target>
    <count>3</count>
    <content>all</content>
    <depth>unbounded</depth>
  </get-bulk>
</rpc>
<rpc-reply message-id="20" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <last-keys><name>eth2</name></last-keys>
    <data>
      <interface><name>eth0</name><enabled>true</enabled></interface>
      <interface><name>eth1</name><enabled>true</enabled></interface>
      <interface><name>eth2</name><enabled>false</enabled></interface>
    </data>
  </bulk>
</rpc-reply>
```

--------------------------------

### Atomic Datastore Locking

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Provides RPCs for atomic all-or-nothing locking of all configuration datastores.

```APIDOC
## Atomic Datastore Locking — `yumaworks-lock`

Provides `<lock-all>` and `<unlock-all>` RPCs for atomic all-or-nothing locking of all configuration datastores (running, candidate, startup) in a single operation.

### Lock All Datastores

```xml
<rpc message-id="30" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <lock-all xmlns="urn:ietf:params:xml:ns:yang:yumaworks-lock"/>
</rpc>
```

### Unlock All Datastores

```xml
<rpc message-id="31" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <unlock-all xmlns="urn:ietf:params:xml:ns:yang:yumaworks-lock"/>
</rpc>
```

### Error Example (Lock Held)

```xml
<rpc-reply message-id="30" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <rpc-error>
    <error-type>protocol</error-type>
    <error-tag>in-use</error-tag>
    <error-severity>error</error-severity>
    <error-message>candidate datastore is locked by session 42</error-message>
  </rpc-error>
</rpc-reply>
```
```

--------------------------------

### Unlock All Datastores

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Use the `<unlock-all>` RPC to release locks on all configuration datastores. This operation is typically paired with `<lock-all>` to ensure atomic operations.

```xml
<rpc message-id="31" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <unlock-all xmlns="urn:ietf:params:xml:ns:yang:yumaworks-lock"/>
</rpc>
```

--------------------------------

### Call Home Configuration

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Defines configuration for RFC 8071 NETCONF Call Home connections using SSH and TLS protocols.

```APIDOC
## Call Home Configuration — `yumaworks-callhome`

Defines the `/callhome/server` configuration list for RFC 8071 NETCONF Call Home connections. Supports SSH and TLS protocols. Entries are create/delete only (immutable after creation).

### Configure Call Home Server (NETCONF)

```xml
<rpc message-id="40" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target><running/></target>
    <config>
      <callhome xmlns="http://yumaworks.com/ns/yumaworks-callhome">
        <server nc:operation="create"
          xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
          <name>nms-primary</name>
          <address>192.0.2.100</address>
          <port>4334</port>
          <protocol>netconf-ssh</protocol>
        </server>
        <server nc:operation="create"
          xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
          <name>nms-backup</name>
          <address>nms-backup.example.com</address>
          <protocol>netconf-tls</protocol>
        </server>
      </callhome>
    </config>
  </edit-config>
</rpc>
```

### Configure Call Home Server (RESTCONF)

```bash
# POST /restconf/data/yumaworks-callhome:callhome/server
# Content-Type: application/yang-data+json
{
  "yumaworks-callhome:server": [
    {
      "name": "nms-primary",
      "address": "192.0.2.100",
      "port": 4334,
      "protocol": "netconf-ssh"
    }
  ]
}
```
```

--------------------------------

### YP-HA Standby Registration via YControl

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

This XML payload demonstrates how a standby YP-HA server registers with the active server using YControl. This is the initial step for establishing a high-availability pair.

```xml
<!-- YP-HA Standby: register with active server via YControl -->
<ycontrol xmlns="http://yumaworks.com/ns/yumaworks-ycontrol">
  <message-payload>
    <payload>
      <payload>
        <yp-ha xmlns="http://yumaworks.com/ns/yumaworks-yp-ha">
          <register-request>
            <subsys-id>standby-node-1</subsys-id>
          </register-request>
        </yp-ha>
      </payload>
    </payload>
  </message-payload>
</ycontrol>
```

--------------------------------

### Next Page Bulk List Retrieval with yumaworks-getbulk

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Continue paginated retrieval by providing the 'last-keys' from the previous response. This allows for stateless iteration over large lists.

```xml
<rpc message-id="21" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-bulk xmlns="http://yumaworks.com/ns/yumaworks-getbulk">
    <list-target>/ietf-interfaces:interfaces/interface</list-target>
    <count>3</count>
    <last-keys><name>eth2</name></last-keys>
  </get-bulk>
</rpc>
```

--------------------------------

### Core NETCONF Protocol Types

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Defines base NETCONF data types, capabilities, and standard RPC operations. Extended by YumaPro for additional edit operations.

```APIDOC
## NETCONF get-config with subtree filter

### Description
Example of a NETCONF get-config RPC using a subtree filter to retrieve interface data.

### Method
POST

### Endpoint
/restconf/operations/netconf

### Request Body
```xml
<rpc message-id="1" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-config>
    <source>
      <running/>
    </source>
    <filter type="subtree">
      <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"/>
    </filter>
  </get-config>
</rpc>
```

### Response
#### Success Response (200)
```xml
<rpc-reply message-id="1" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <data>
    <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
      <interface>
        <name>eth0</name>
        <type xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type">
          ianaift:ethernetCsmacd
        </type>
        <enabled>true</enabled>
      </interface>
    </interfaces>
  </data>
</rpc-reply>
```

## NETCONF edit-config with YumaPro delete-all operation

### Description
Example of a NETCONF edit-config RPC using the YumaPro-specific `delete-all` operation to remove all interfaces.

### Method
POST

### Endpoint
/restconf/operations/netconf

### Request Body
```xml
<rpc message-id="2" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target><candidate/></target>
    <config>
      <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
        <interface nc:operation="delete-all"
          xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"/>
      </interfaces>
    </config>
  </edit-config>
</rpc>
```
```

--------------------------------

### YP-HA Active Server Pushing Configuration Update

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

This XML payload shows the active YP-HA server sending a configuration update to the standby server. The actual YANG Patch payload would detail the configuration changes.

```xml
<!-- Active server pushes config update to standby -->
<ycontrol xmlns="http://yumaworks.com/ns/yumaworks-ycontrol">
  <message-payload>
    <payload>
      <payload>
        <yp-ha xmlns="http://yumaworks.com/ns/yumaworks-yp-ha">
          <config-update>
            <!-- YANG Patch payload with configuration delta -->
          </config-update>
        </yp-ha>
      </payload>
    </payload>
  </message-payload>
</ycontrol>
```

--------------------------------

### Notification Event Filtering

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Defines configuration for filtering YANG notification events from the replay buffer.

```APIDOC
## Notification Event Filtering — `yumaworks-event-filter`

Defines the `/event-filters` configuration container for suppressing or enabling specific YANG notification events from being buffered in the replay buffer. When the container is present, the event filtering service is active.

### Configure Event Filtering (NETCONF)

```xml
<rpc message-id="50" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target><running/></target>
    <config>
      <event-filters xmlns="http://yumaworks.com/ns/yumaworks-event-filter">
        <!-- Enable link-up notifications for replay -->
        <event-filter>
          <module>ietf-interfaces</module>
          <event>link-up</event>
          <enabled>true</enabled>
          <log-drops>false</log-drops>
        </event-filter>
        <!-- Disable (suppress) link-down events -->
        <event-filter>
          <module>ietf-interfaces</module>
          <event>link-down</event>
          <enabled>false</enabled>
          <log-drops>true</log-drops>
        </event-filter>
      </event-filters>
    </config>
  </edit-config>
</rpc>
```

### Subscribe to Notifications with Replay (NETCONF)

```xml
<rpc message-id="51" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
    <stream>NETCONF</stream>
    <startTime>2025-01-01T00:00:00Z</startTime>
  </create-subscription>
</rpc>
```
```

--------------------------------

### Server System Operations

Source: https://context7.com/yumaworks/yumapro-yang/llms.txt

Provides YumaPro-specific RPC operations for server administration, including configuration backup/restore, dynamic module load/unload, log-level control, high-availability status query, protocol enable/disable, and NETCONF subscription management.

```APIDOC
## backup

### Description
Backs up the running configuration to a specified file.

### Method
POST

### Endpoint
/restconf/operations/yumaworks-system:backup

### Parameters
#### Request Body
- **filename** (string) - Required - The name of the file to save the backup to.
- **overwrite** (boolean) - Optional - Whether to overwrite the file if it already exists. Defaults to false.

### Request Example
```xml
<rpc message-id="10" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <backup xmlns="http://yumaworks.com/ns/yumaworks-system">
    <filename>backup-2025-01</filename>
    <overwrite>false</overwrite>
  </backup>
</rpc>
```

## restore

### Description
Restores a saved configuration from a specified file.

### Method
POST

### Endpoint
/restconf/operations/yumaworks-system:restore

### Parameters
#### Request Body
- **filename** (string) - Required - The name of the file to restore the configuration from.

### Request Example
```xml
<rpc message-id="11" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <restore xmlns="http://yumaworks.com/ns/yumaworks-system">
    <filename>backup-2025-01</filename>
  </restore>
</rpc>
```

## load

### Description
Loads a YANG module dynamically.

### Method
POST

### Endpoint
/restconf/operations/yumaworks-system:load

### Parameters
#### Request Body
- **module** (string) - Required - The name of the module to load.
- **save-config** (boolean) - Optional - Whether to save the configuration after loading the module. Defaults to false.

### Request Example
```xml
<rpc message-id="12" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <load xmlns="http://yumaworks.com/ns/yumaworks-system">
    <module>my-vendor-module</module>
    <save-config>true</save-config>
  </load>
</rpc>
```

### Response
#### Success Response (200)
- **mod-revision** (string) - The revision date of the loaded module.

### Response Example
```xml
<rpc-reply message-id="12" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <mod-revision xmlns="http://yumaworks.com/ns/yumaworks-system">
    2024-06-01
  </mod-revision>
</rpc-reply>
```

## set-log-level

### Description
Sets the server log level for a specific log stream.

### Method
POST

### Endpoint
/restconf/operations/yumaworks-system:set-log-level

### Parameters
#### Request Body
- **log-level** (string) - Required - The desired log level (e.g., debug2).
- **log-stream** (string) - Required - The log stream to apply the level to (e.g., audit).

### Request Example
```xml
<rpc message-id="13" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <set-log-level xmlns="http://yumaworks.com/ns/yumaworks-system">
    <log-level>debug2</log-level>
    <log-stream>audit</log-stream>
  </set-log-level>
</rpc>
```

## get-server-version

### Description
Retrieves the server version and build date.

### Method
GET

### Endpoint
/restconf/operations/yumaworks-system:get-server-version

### Response
#### Success Response (200)
- **version** (string) - The server version.
- **build-date** (string) - The build date of the server.

### Response Example
```xml
<rpc-reply message-id="14" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <version xmlns="http://yumaworks.com/ns/yumaworks-system">25.10-3</version>
  <build-date xmlns="http://yumaworks.com/ns/yumaworks-system">2025-11-24</build-date>
</rpc-reply>
```

## protocol-control

### Description
Enables or disables a protocol at runtime.

### Method
POST

### Endpoint
/restconf/operations/yumaworks-system:protocol-control

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform (e.g., disable).
- **protocol** (string) - Required - The protocol to control (e.g., restconf).

### Request Example
```xml
<rpc message-id="15" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <protocol-control xmlns="http://yumaworks.com/ns/yumaworks-system">
    <action>disable</action>
    <protocol>restconf</protocol>
  </protocol-control>
</rpc>
```

## get-ha-status

### Description
Retrieves the high-availability status of the server.

### Method
GET

### Endpoint
/restconf/operations/yumaworks-system:get-ha-status

### Response
#### Success Response (200)
- (No specific fields documented in the source for success response)

### Response Example
```xml
<rpc message-id="16" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <get-ha-status xmlns="http://yumaworks.com/ns/yumaworks-system"/>
</rpc>
```
```
Tokens:
Raw