| access-control-mode |
enumeration |
|
| access-control-mode |
enumeration |
|
| AltNameMode |
boolean |
Defines the alternate name search mode that
should be used when resolving YANG node names
in leafs or leaflists using the UrlPath data type.
If 'true' then nodes with an 'alt-name' defined
will be considered a match if the YANG name or the
alternative name matches the search string.
If 'false' then only the YANG node name will
be used in node name searches. |
| AltNameMode |
boolean |
Defines the alternate name search mode that
should be used when resolving YANG node names
in leafs or leaflists using the UrlPath data type.
If 'true' then nodes with an 'alt-name' defined
will be considered a match if the YANG name or the
alternative name matches the search string.
If 'false' then only the YANG node name will
be used in node name searches. |
| encoding-type |
enumeration |
The message encoding format to use |
| encoding-type |
enumeration |
The message encoding format to use |
| lsid-size |
enumeration |
If the yang-sid-mode is 'lsid' or 'lsid-file' then the server
implementation will pick a SID size at build-time. |
| NameMatchMode |
enumeration |
Defines the search mode that should be used
when resolving YANG node names in leafs and
leaf-lists using the UrlPath data type. |
| NameMatchMode |
enumeration |
Defines the search mode that should be used
when resolving YANG node names in leafs and
leaf-lists using the UrlPath data type. |
| NcxFileName |
string |
General Purpose NCX File Name string.
The first character can be a letter, digit, or
underscore character. The rest of the characters can be
printable characters except the following characters:
* space ( ) ASCII 32
* double quote ASCII 34
* ampersand (&) ASCII 38
* comma (,) ASCII 44
* forward slash (/) ASCII 47
* less-than sign (<) ASCII 60
* question mark (?) ASCII 63
* backslash (\\) ASCII 92
* left curly brace ({) ASCII 123
* vertical bar (|) ASCII 124
The allowed characters are not special to the server but many
of them would be interpreted as special characters by other
programs. Use such characters with extreme caution. |
| NcxFileName |
string |
General Purpose NCX File Name string.
The first character can be a letter, digit, or
underscore character. The rest of the characters can be
printable characters except the following characters:
* space ( ) ASCII 32
* double quote ASCII 34
* ampersand (&) ASCII 38
* comma (,) ASCII 44
* forward slash (/) ASCII 47
* less-than sign (<) ASCII 60
* question mark (?) ASCII 63
* backslash (\\) ASCII 92
* left curly brace ({) ASCII 123
* vertical bar (|) ASCII 124
The allowed characters are not special to the server but many
of them would be interpreted as special characters by other
programs. Use such characters with extreme caution. |
| NcxNumName |
string |
General Purpose NCX Name string. This is the
same as an NcxName except the first character
is also allowed to be a number. |
| NcxNumName |
string |
General Purpose NCX Name string. This is the
same as an NcxName except the first character
is also allowed to be a number. |
| server-target |
enumeration |
The database to use as the target of edit-config
and copy-config operations. |
| server-target |
enumeration |
The database to use as the target of edit-config
and copy-config operations. |
| show-mode |
enumeration |
The mode that a command or prompt should be displayed.
Selects the verbosity level of the output. |
| show-mode |
enumeration |
The mode that a command or prompt should be displayed.
Selects the verbosity level of the output. |
| transport-type |
enumeration |
Identifies the transport protocol that should be used. |
| transport-type |
enumeration |
Identifies the transport protocol that should be used. |
| UrlPath |
string |
Special URL encoded path expression.
Normal Encoding Rules:
- Normal content is encoded as an absolute path.
- Keys are encoded as a path step within the URL,
instead of a predicate expression like XPath.
- The first character must be a forward slash '/'.
- Each identifier or key encoded in the URL string
is separated by a single forward slash '/' character.
- Escaped character sequences are allowed, such
as '%20' for the space ' ' character.
- If any descendant nodes of a list are included,
then all key leafs for that list must be encoded
in the URL (or escaped with the dash '-' character
to skip that key).
- Only key leafs can be encoded within the URL string,
similar to a YANG instance-identifier or
schema-instance-identifier string. Other leafs
are not allowed.
Example URL and XPath strings:
XPath: /foo/bar[id='fred'][id2='barney]/baz
UrlPath: /foo/bar/fred/barney/baz
Example showing the 'id2' key leaf escaped:
XPath: /foo/bar[id='fred']/baz
UrlPath: /foo/bar/fred/-/baz
Special Encoding Rules
Since these escaped characters are usually decoded
by the time an HTTP gateway program will get them,
the forward slash '/' character needs to be treated
differently. To use this character within key leaf
content, it must be escaped with another forward
slash character.
Example showing escaped forward slash in content:
XPath: /interfaces/interface[name='1/0/22']/mtu
URLPath: /interfaces/interface/1//0//22/mtu
Name Matching
A parameter using the 'NameMatchMode' data type
can be used to control how name node searches
are done for nodes using this data type.
Alternate Naming
A parameter using the 'AltNameMode' data type
can be used to control whether alternative
node names can be used when name searches
are done for nodes using this data type.
Exceptions:
XML namespaces are not ignored, but if multiple
sibling nodes have the same local-name, then
the first node found will be used.
|
| UrlPath |
string |
Special URL encoded path expression.
Normal Encoding Rules:
- Normal content is encoded as an absolute path.
- Keys are encoded as a path step within the URL,
instead of a predicate expression like XPath.
- The first character must be a forward slash '/'.
- Each identifier or key encoded in the URL string
is separated by a single forward slash '/' character.
- Escaped character sequences are allowed, such
as '%20' for the space ' ' character.
- If any descendant nodes of a list are included,
then all key leafs for that list must be encoded
in the URL (or escaped with the dash '-' character
to skip that key).
- Only key leafs can be encoded within the URL string,
similar to a YANG instance-identifier or
schema-instance-identifier string. Other leafs
are not allowed.
Example URL and XPath strings:
XPath: /foo/bar[id='fred'][id2='barney]/baz
UrlPath: /foo/bar/fred/barney/baz
Example showing the 'id2' key leaf escaped:
XPath: /foo/bar[id='fred']/baz
UrlPath: /foo/bar/fred/-/baz
Special Encoding Rules
Since these escaped characters are usually decoded
by the time an HTTP gateway program will get them,
the forward slash '/' character needs to be treated
differently. To use this character within key leaf
content, it must be escaped with another forward
slash character.
Example showing escaped forward slash in content:
XPath: /interfaces/interface[name='1/0/22']/mtu
URLPath: /interfaces/interface/1//0//22/mtu
Name Matching
A parameter using the 'NameMatchMode' data type
can be used to control how name node searches
are done for nodes using this data type.
Alternate Naming
A parameter using the 'AltNameMode' data type
can be used to control whether alternative
node names can be used when name searches
are done for nodes using this data type.
Exceptions:
XML namespaces are not ignored, but if multiple
sibling nodes have the same local-name, then
the first node found will be used.
|
| yang-sid-mode |
enumeration |
The source of SID assignments for YANG schema items. |