gNOI - Factory Reset v0.1.0

The FactoryReset service exported by Targets.

Method Name	Request / Response Type	Description
Start	StartRequest StartResponse	The Start RPC allows the Client to instruct the Target to immediately clean all existing state and boot the Target in the same condition as it is shipped from factory. State includes storage, configuration, logs, certificates and licenses. Optionally allows rolling back the OS to the same version shipped from factory. Optionally allows for the Target to zero-fill permanent storage where state data is stored. If any of the optional flags is set but not supported, a gRPC Status with code INVALID_ARGUMENT must be returned with the details value set to a properly populated ResetError message.

messages

ResetError

Message also used in gRPC status.details field.

Field	Type	Description
factory_os_unsupported	bool	Factory OS reset is not supported.
zero_fill_unsupported	bool	Zero fill is not supported.
other	bool	Unspecified error, must provide detail message.
detail	string

ResetSuccess

Empty message

StartRequest

Field	Type	Description
factory_os	bool	Instructs the Target to rollback the OS to the same version as it shipped from factory.
zero_fill	bool	Instructs the Target to zero fill persistent storage state data.

StartResponse

Field	Type	Description
response (one of)
reset_success	ResetSuccess	Reset will be executed.
reset_error	ResetError	Reset will not be executed.

messages

Credentials

Credentials defines credentials needed to perform authentication on a device.

Field	Type	Description
username	string
password (one of)
cleartext	string
hashed	HashType

HashType

HashType defines the valid hash methods for data verification. UNSPECIFIED
should be treated an error.

Field	Type	Description
method	HashType.HashMethod
hash	bytes

Path

Path encodes a data tree path as a series of repeated strings, with
each element of the path representing a data tree node name and the
associated attributes.
Reference: gNMI Specification Section 2.2.2.

Field	Type	Description
origin	string	Label to disambiguate path.
elem (repeated)	PathElem	Elements of the path.

PathElem

PathElem encodes an element of a gNMI path, along with any attributes (keys)
that may be associated with it.
Reference: gNMI Specification Section 2.2.2.

Field	Type	Description
name	string	The name of the element in the path.
key (repeated)	PathElem.KeyEntry	Map of key (attribute) name to value.

PathElem.KeyEntry

Field	Type	Description
key	string
value	string

enums

HashType.HashMethod

Name	Number	Description
UNSPECIFIED	0
SHA256	1
SHA512	2
MD5	3

L3Protocol

Generic Layer 3 Protocol enumeration.

Name	Number	Description
UNSPECIFIED	0
IPV4	1
IPV6	2

extensions

.google.protobuf.FileOptions.gnoi_version

The gNOI service semantic version.

Extension	Type	Base	Number	Description
gnoi_version	string	.google.protobuf.FileOptions	1002	The gNOI service semantic version.

Scalar Value Types

Proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)