PUT: Change global configuration settings

The global configuration of an Asset Discovery node changed with a PUT command referencing the root element of the URL. Note that this is about access credentials for endpoints on your discovered networks, not credentials to access OT-BASE Asset Discovery.

Changing configuration settings

You can change configuration settings in the body of your PUT command as illustrated in the following example:

{
        "wmi": {
              "credentials": [{
                    "description": "WMI user",
                    "user": "WMI user name",
                    "password": "WMI password"
              },
              {
                    "description": "Other WMI user",
                    "user": "Other WMI user name",
                    "password": "Other WMI password"
              }]
        },
       "ssh": {
              "credentials": [{
                    "description": "SSH user",
                    "user": "SSH user name",
                    "password": "SSH password",
                    "port": 123,
                    "timeout": 30
              }]
        },
        "snmp": {
              "credentials": [{
                    "description": "V1 public community",
                    "version": 1,
                    "community": "public"
              },
              {
                    "description": "V2 public community",
                    "version": 2,
                    "community": "public"
              },
              {
                    "description": "V3 user",
                    "version": 3,
                    "user": "SNMP user",
                    "authProtocol": "None",
                    "authKey": "",
                    "privProtocol": "None",
                    "privKey": ""
              }]
        },
        "winrm": {
              "credentials": [{
                    "description": "WinRM user",
                    "user": "WinRM user name",
                    "password": "WinRM password",
                    "authentication": "negotiate",
                    "encryption": "auto",
                    "port": 5985,
                    "ssl": false
              },
              {
                    "description": "Other WinRM user",
                    "user": "Other WinRM user name",
                    "password": "Other WinRM password",
                    "authentication": "basic",
                    "encryption": "never",
                    "ssl": true,
                    "certValidation": false
              }]
        },

        "modbus": {
              "credentials": [{
                    "description": "Modbus default",
                    "port": 502,
                    "timeout": 30
              }]
        },

        "roc": {
              "credentials": [{
                    "description": "Roc default",
                    "port": 4000,
                    "timeout": 30,
                    "deviceUnit": 240,
                    "deviceGroup": 240,
                    "hostUnit": 2,
                    "hostGroup": 1,
                    "checkCRC": true
              }]
        },

        "credentials": {

              "admin": {

                    "user": "Admin user",

                    "password": "Admin password"

              },

              "rest": {

                    "user": "Rest user",

                    "password": "Rest password"

              },

              "ldap": {

                    "servers": ["Preferred_server_1", "ldap://Preferred_server_2", "ldaps://Preferred_server_3"],

                    "users": ["Authorized_user_1@domain_1", "Authorized_user_2@domain_2"],

                    "groups": ["Authorized _group_1@domain_1", "Authorized _group_2@domain_2"]

              }

        }
}

Where "SNMP auth protocol" is one of:

    'none', 'md5', 'sha', 'sha224', 'sha256', 'sha384', 'sha512'

"SNMP priv protocol" is one of:

    'none', 'des', '3desede', 'aescfbB128', 'aescfb192', 'aescfb256', 'aesblumenthal192', 'aesblumenthal256'

"WinRM authentication" is one of:

    'negotiate', 'basic'

and "WinRM encryption" is one of:

    'auto', 'always', 'never'

You can only set all endpoint protocol access credentials at once. For security reasons, there is no way to retrieve the current credentials.

Removing all endpoint protocol access credentials

You can remove all endpoint protocol access credentials by using an empty list:

    "credentials": []