editSNMPUser

The editSNMPUser operation handles configuration related to SNMPUser model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name	True	string	The SNMPv3 username. Usernames must be 32 characters or less.
description	False	string	Description of the object. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
securityLevel	True	string	An enum value that defines the security level for the user. Allowed values are AUTH, NOAUTH or PRIV. AUTH - Authentication but No Privacy, which means that messages are authenticated, NOAUTH — No Authentication and No Privacy, which means that no security is applied to messages, PRIV — Authentication and Privacy, which means that messages are authenticated and encrypted. Field level constraints: cannot be null. (Note: Additional constraints might exist)
authenticationAlgorithm	False	string	An enum value that specifies the encryption algorithm to use. Allowed values are SHA, SHA256. Must be null if securityLevel is NOAUTH. Must not be null if securityLevel is AUTH or PRIV.
authenticationPassword	False	string	The password to use for authentication. Must be null if securityLevel is NOAUTH. Must not be null if securityLevel is AUTH or PRIV. If you selected an authentication encryption algorithm, the password must be formatted as xx:xx:xx..., where xx are hexadecimal values. The length of the password will depend on the authentication algorithm selected. For all passwords, the length must be 256 characters or less.
encryptionAlgorithm	False	string	An enum value that defines the type of encryption you want to use: AES128, AES192, AES256, 3DES. Must be null if securityLevel is NOAUTH or AUTH. Must not be null if securityLevel is PRIV
encryptionPassword	False	string	The encryption password if you enable encryption. Must be null if securityLevel is NOAUTH or AUTH. Must not be null if securityLevel is PRIV. The password must be formatted as xx:xx:xx..., where xx are hexadecimal values. For encrypted passwords, the length of the password depends on the encryption type selected. The password sizes are as follows (where each xx is one octal), but for all passwords the length must be 128 characters or less: AES 128 requires 16 octals, AES 192 requires 24 octals, AES 256 requires 32 octals, 3DES requires 32 octals
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editSNMPUser' operation
  ftd_configuration:
    operation: "editSNMPUser"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        securityLevel: "{{ security_level }}"
        authenticationAlgorithm: "{{ authentication_algorithm }}"
        authenticationPassword: "{{ authentication_password }}"
        encryptionAlgorithm: "{{ encryption_algorithm }}"
        encryptionPassword: "{{ encryption_password }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"