Returns list of credential profiles.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v1/op/credentialProfilesManagement/credentialProfiles
Response Parameters
cliParameters
CliParametersDTO
|
|
cliEnablePassword
String
|
|
cliPassword
String
|
|
cliPort
Integer
|
The CLI port. The port range is 1-65535. This field is mandatory.
|
cliProtocol
CliProtocol
|
The CLI protocol. This field is mandatory.
Allowed values:
TELNET
SSH
|
cliTimeout
Integer
|
The CLI timeout. The timeout range is 1-300 secs. This field is mandatory.
|
cliUsername
String
|
|
|
description
String
|
The description of the credential profile.
|
httpParameters
HttpParametersDTO
|
The http/https parameters.
|
httpMonitorPassword
String
|
The http/https monitor password.
|
httpMonitorUsername
String
|
The http/https monitor username.
|
httpPassword
String
|
|
httpPort
Integer
|
The http/https port. The port range is 0-65535. This field is mandatory.
|
httpProtocol
HttpProtocol
|
The http/https protocol.
Allowed values:
HTTP
HTTPS
|
httpUsername
String
|
|
|
profileName
String
|
The name of the credential profile. This field is mandatory.
|
snmpParameters
SnmpParametersDTO
|
|
readCommunity
String
|
The SNMP read community for monitoring devices. This field is provided only for SNMP versions 1/2c and is mandatory for these versions.
|
snmpPort
Integer
|
The SNMP port. The port range is 1-65535. This field is mandatory.
|
snmpRetries
Integer
|
The number of SNMP Retries. Retries range is 1-10. This field is mandatory.
|
snmpTimeout
Integer
|
The SNMP timeout. The timeout range is 1-300 secs. This field is mandatory.
|
snmpV3AuthPassword
String
|
The SNMP authorization password. This field is provided only for SNMP version 3.
|
snmpV3AuthType
SnmpV3AuthorizationType
|
The SNMP authorization type. This field is provided only for SNMP version 3 and is mandatory for this version.
Allowed values:
NONE
HMAC_MD5
HMAC_SHA
|
snmpV3PrivacyPassword
String
|
The SNMP privacy password. This field is provided only for SNMP version 3.
|
snmpV3PrivacyType
SnmpV3PrivacyType
|
The SNMP privacy type. This field is provided only for SNMP version 3 and is mandatory for this version.
Allowed values:
NONE
CBC_DES
CFB_AES_128
|
snmpV3Username
String
|
The SNMP username. This field is provided only for SNMP version 3.
|
snmpVersion
SnmpVersion
|
SNMP version. This field is mandatory.
Allowed values:
V1
V2C
V3
|
writeCommunity
String
|
The SNMP write community for configuring devices. This field is provided only for SNMP versions 1 and 2c.
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/credentialProfilesManagement/credentialProfiles
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/credentialProfilesManagement/credentialProfiles" rootUrl="https://localhost/webacs/api/v1/op">
<credentialProfilesDTO>
<cliParameters>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliPort>15</cliPort>
<cliProtocol>TELNET</cliProtocol>
<cliTimeout>15</cliTimeout>
<cliUsername>String value</cliUsername>
</cliParameters>
<description>String value</description>
<httpParameters>
<httpMonitorPassword>String value</httpMonitorPassword>
<httpMonitorUsername>String value</httpMonitorUsername>
<httpPassword>String value</httpPassword>
<httpPort>15</httpPort>
<httpProtocol>HTTP</httpProtocol>
<httpUsername>String value</httpUsername>
</httpParameters>
<profileName>String value</profileName>
<snmpParameters>
<readCommunity>String value</readCommunity>
<snmpPort>15</snmpPort>
<snmpRetries>15</snmpRetries>
<snmpTimeout>15</snmpTimeout>
<snmpV3AuthPassword>String value</snmpV3AuthPassword>
<snmpV3AuthType>NONE</snmpV3AuthType>
<snmpV3PrivacyPassword>String value</snmpV3PrivacyPassword>
<snmpV3PrivacyType>NONE</snmpV3PrivacyType>
<snmpV3Username>String value</snmpV3Username>
<snmpVersion>V1</snmpVersion>
<writeCommunity>String value</writeCommunity>
</snmpParameters>
</credentialProfilesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/credentialProfilesManagement/credentialProfiles.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/credentialProfilesManagement\/credentialProfiles",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"credentialProfilesDTO" : {
"cliParameters" : {
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliPort" : 15,
"cliProtocol" : "TELNET",
"cliTimeout" : 15,
"cliUsername" : "String value"
},
"description" : "String value",
"httpParameters" : {
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPassword" : "String value",
"httpPort" : 15,
"httpProtocol" : "HTTP",
"httpUsername" : "String value"
},
"profileName" : "String value",
"snmpParameters" : {
"readCommunity" : "String value",
"snmpPort" : 15,
"snmpRetries" : 15,
"snmpTimeout" : 15,
"snmpV3AuthPassword" : "String value",
"snmpV3AuthType" : "NONE",
"snmpV3PrivacyPassword" : "String value",
"snmpV3PrivacyType" : "NONE",
"snmpV3Username" : "String value",
"snmpVersion" : "V1",
"writeCommunity" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/credentialProfilesManagement/credentialProfiles
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
cliParameters
CliParametersDTO
|
|
cliEnablePassword
String
|
|
cliPassword
String
|
|
cliPort
Integer
|
The CLI port. The port range is 1-65535. This field is mandatory.
|
cliProtocol
CliProtocol
|
The CLI protocol. This field is mandatory.
Allowed values:
TELNET
SSH
|
cliTimeout
Integer
|
The CLI timeout. The timeout range is 1-300 secs. This field is mandatory.
|
cliUsername
String
|
|
|
description
String
|
The description of the credential profile.
|
httpParameters
HttpParametersDTO
|
The http/https parameters.
|
httpMonitorPassword
String
|
The http/https monitor password.
|
httpMonitorUsername
String
|
The http/https monitor username.
|
httpPassword
String
|
|
httpPort
Integer
|
The http/https port. The port range is 0-65535. This field is mandatory.
|
httpProtocol
HttpProtocol
|
The http/https protocol.
Allowed values:
HTTP
HTTPS
|
httpUsername
String
|
|
|
profileName
String
|
The name of the credential profile. This field is mandatory.
|
snmpParameters
SnmpParametersDTO
|
|
readCommunity
String
|
The SNMP read community for monitoring devices. This field is provided only for SNMP versions 1/2c and is mandatory for these versions.
|
snmpPort
Integer
|
The SNMP port. The port range is 1-65535. This field is mandatory.
|
snmpRetries
Integer
|
The number of SNMP Retries. Retries range is 1-10. This field is mandatory.
|
snmpTimeout
Integer
|
The SNMP timeout. The timeout range is 1-300 secs. This field is mandatory.
|
snmpV3AuthPassword
String
|
The SNMP authorization password. This field is provided only for SNMP version 3.
|
snmpV3AuthType
SnmpV3AuthorizationType
|
The SNMP authorization type. This field is provided only for SNMP version 3 and is mandatory for this version.
Allowed values:
NONE
HMAC_MD5
HMAC_SHA
|
snmpV3PrivacyPassword
String
|
The SNMP privacy password. This field is provided only for SNMP version 3.
|
snmpV3PrivacyType
SnmpV3PrivacyType
|
The SNMP privacy type. This field is provided only for SNMP version 3 and is mandatory for this version.
Allowed values:
NONE
CBC_DES
CFB_AES_128
|
snmpV3Username
String
|
The SNMP username. This field is provided only for SNMP version 3.
|
snmpVersion
SnmpVersion
|
SNMP version. This field is mandatory.
Allowed values:
V1
V2C
V3
|
writeCommunity
String
|
The SNMP write community for configuring devices. This field is provided only for SNMP versions 1 and 2c.
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/credentialProfilesManagement/credentialProfiles
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/credentialProfilesManagement/credentialProfiles" rootUrl="https://localhost/webacs/api/v2/op">
<credentialProfilesDTO>
<cliParameters>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliPort>15</cliPort>
<cliProtocol>TELNET</cliProtocol>
<cliTimeout>15</cliTimeout>
<cliUsername>String value</cliUsername>
</cliParameters>
<description>String value</description>
<httpParameters>
<httpMonitorPassword>String value</httpMonitorPassword>
<httpMonitorUsername>String value</httpMonitorUsername>
<httpPassword>String value</httpPassword>
<httpPort>15</httpPort>
<httpProtocol>HTTP</httpProtocol>
<httpUsername>String value</httpUsername>
</httpParameters>
<profileName>String value</profileName>
<snmpParameters>
<readCommunity>String value</readCommunity>
<snmpPort>15</snmpPort>
<snmpRetries>15</snmpRetries>
<snmpTimeout>15</snmpTimeout>
<snmpV3AuthPassword>String value</snmpV3AuthPassword>
<snmpV3AuthType>NONE</snmpV3AuthType>
<snmpV3PrivacyPassword>String value</snmpV3PrivacyPassword>
<snmpV3PrivacyType>NONE</snmpV3PrivacyType>
<snmpV3Username>String value</snmpV3Username>
<snmpVersion>V1</snmpVersion>
<writeCommunity>String value</writeCommunity>
</snmpParameters>
</credentialProfilesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/credentialProfilesManagement/credentialProfiles.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/credentialProfilesManagement/credentialProfiles",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"credentialProfilesDTO" : [ {
"cliParameters" : {
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliPort" : 15,
"cliProtocol" : "TELNET",
"cliTimeout" : 15,
"cliUsername" : "String value"
},
"description" : "String value",
"httpParameters" : {
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPassword" : "String value",
"httpPort" : 15,
"httpProtocol" : "HTTP",
"httpUsername" : "String value"
},
"profileName" : "String value",
"snmpParameters" : {
"readCommunity" : "String value",
"snmpPort" : 15,
"snmpRetries" : 15,
"snmpTimeout" : 15,
"snmpV3AuthPassword" : "String value",
"snmpV3AuthType" : "NONE",
"snmpV3PrivacyPassword" : "String value",
"snmpV3PrivacyType" : "NONE",
"snmpV3Username" : "String value",
"snmpVersion" : "V1",
"writeCommunity" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/credentialProfilesManagement/credentialProfiles
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
cliParameters
CliParametersDTO
|
|
cliEnablePassword
String
|
|
cliPassword
String
|
|
cliPort
Integer
|
The CLI port. The port range is 1-65535. This field is mandatory.
|
cliProtocol
CliProtocol
|
The CLI protocol. This field is mandatory.
Allowed values:
TELNET
SSH
|
cliTimeout
Integer
|
The CLI timeout. The timeout range is 1-300 secs. This field is mandatory.
|
cliUsername
String
|
|
|
description
String
|
The description of the credential profile.
|
httpParameters
HttpParametersDTO
|
The http/https parameters.
|
httpMonitorPassword
String
|
The http/https monitor password.
|
httpMonitorUsername
String
|
The http/https monitor username.
|
httpPassword
String
|
|
httpPort
Integer
|
The http/https port. The port range is 0-65535. This field is mandatory.
|
httpProtocol
HttpProtocol
|
The http/https protocol.
Allowed values:
HTTP
HTTPS
|
httpUsername
String
|
|
|
profileName
String
|
The name of the credential profile. This field is mandatory.
|
snmpParameters
SnmpParametersDTO
|
|
readCommunity
String
|
The SNMP read community for monitoring devices. This field is provided only for SNMP versions 1/2c and is mandatory for these versions.
|
snmpPort
Integer
|
The SNMP port. The port range is 1-65535. This field is mandatory.
|
snmpRetries
Integer
|
The number of SNMP Retries. Retries range is 1-10. This field is mandatory.
|
snmpTimeout
Integer
|
The SNMP timeout. The timeout range is 1-300 secs. This field is mandatory.
|
snmpV3AuthPassword
String
|
The SNMP authorization password. This field is provided only for SNMP version 3.
|
snmpV3AuthType
SnmpV3AuthorizationType
|
The SNMP authorization type. This field is provided only for SNMP version 3 and is mandatory for this version.
Allowed values:
NONE
HMAC_MD5
HMAC_SHA
|
snmpV3PrivacyPassword
String
|
The SNMP privacy password. This field is provided only for SNMP version 3.
|
snmpV3PrivacyType
SnmpV3PrivacyType
|
The SNMP privacy type. This field is provided only for SNMP version 3 and is mandatory for this version.
Allowed values:
NONE
CBC_DES
CFB_AES_128
|
snmpV3Username
String
|
The SNMP username. This field is provided only for SNMP version 3.
|
snmpVersion
SnmpVersion
|
SNMP version. This field is mandatory.
Allowed values:
V1
V2C
V3
|
writeCommunity
String
|
The SNMP write community for configuring devices. This field is provided only for SNMP versions 1 and 2c.
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/credentialProfilesManagement/credentialProfiles
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/credentialProfilesManagement/credentialProfiles" rootUrl="https://localhost/webacs/api/v3/op">
<credentialProfilesDTO>
<cliParameters>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliPort>15</cliPort>
<cliProtocol>TELNET</cliProtocol>
<cliTimeout>15</cliTimeout>
<cliUsername>String value</cliUsername>
</cliParameters>
<description>String value</description>
<httpParameters>
<httpMonitorPassword>String value</httpMonitorPassword>
<httpMonitorUsername>String value</httpMonitorUsername>
<httpPassword>String value</httpPassword>
<httpPort>15</httpPort>
<httpProtocol>HTTP</httpProtocol>
<httpUsername>String value</httpUsername>
</httpParameters>
<profileName>String value</profileName>
<snmpParameters>
<readCommunity>String value</readCommunity>
<snmpPort>15</snmpPort>
<snmpRetries>15</snmpRetries>
<snmpTimeout>15</snmpTimeout>
<snmpV3AuthPassword>String value</snmpV3AuthPassword>
<snmpV3AuthType>NONE</snmpV3AuthType>
<snmpV3PrivacyPassword>String value</snmpV3PrivacyPassword>
<snmpV3PrivacyType>NONE</snmpV3PrivacyType>
<snmpV3Username>String value</snmpV3Username>
<snmpVersion>V1</snmpVersion>
<writeCommunity>String value</writeCommunity>
</snmpParameters>
</credentialProfilesDTO>
<credentialProfilesDTO>
<cliParameters>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliPort>15</cliPort>
<cliProtocol>TELNET</cliProtocol>
<cliTimeout>15</cliTimeout>
<cliUsername>String value</cliUsername>
</cliParameters>
<description>Another string value</description>
<httpParameters>
<httpMonitorPassword>String value</httpMonitorPassword>
<httpMonitorUsername>String value</httpMonitorUsername>
<httpPassword>String value</httpPassword>
<httpPort>15</httpPort>
<httpProtocol>HTTP</httpProtocol>
<httpUsername>String value</httpUsername>
</httpParameters>
<profileName>Another string value</profileName>
<snmpParameters>
<readCommunity>String value</readCommunity>
<snmpPort>15</snmpPort>
<snmpRetries>15</snmpRetries>
<snmpTimeout>15</snmpTimeout>
<snmpV3AuthPassword>String value</snmpV3AuthPassword>
<snmpV3AuthType>NONE</snmpV3AuthType>
<snmpV3PrivacyPassword>String value</snmpV3PrivacyPassword>
<snmpV3PrivacyType>NONE</snmpV3PrivacyType>
<snmpV3Username>String value</snmpV3Username>
<snmpVersion>V1</snmpVersion>
<writeCommunity>String value</writeCommunity>
</snmpParameters>
</credentialProfilesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/credentialProfilesManagement/credentialProfiles.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/credentialProfilesManagement/credentialProfiles",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"credentialProfilesDTO" : [ {
"cliParameters" : {
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliPort" : 15,
"cliProtocol" : "TELNET",
"cliTimeout" : 15,
"cliUsername" : "String value"
},
"description" : "String value",
"httpParameters" : {
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPassword" : "String value",
"httpPort" : 15,
"httpProtocol" : "HTTP",
"httpUsername" : "String value"
},
"profileName" : "String value",
"snmpParameters" : {
"readCommunity" : "String value",
"snmpPort" : 15,
"snmpRetries" : 15,
"snmpTimeout" : 15,
"snmpV3AuthPassword" : "String value",
"snmpV3AuthType" : "NONE",
"snmpV3PrivacyPassword" : "String value",
"snmpV3PrivacyType" : "NONE",
"snmpV3Username" : "String value",
"snmpVersion" : "V1",
"writeCommunity" : "String value"
}
}, {
"cliParameters" : {
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliPort" : 15,
"cliProtocol" : "TELNET",
"cliTimeout" : 15,
"cliUsername" : "String value"
},
"description" : "Another string value",
"httpParameters" : {
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPassword" : "String value",
"httpPort" : 15,
"httpProtocol" : "HTTP",
"httpUsername" : "String value"
},
"profileName" : "Another string value",
"snmpParameters" : {
"readCommunity" : "String value",
"snmpPort" : 15,
"snmpRetries" : 15,
"snmpTimeout" : 15,
"snmpV3AuthPassword" : "String value",
"snmpV3AuthType" : "NONE",
"snmpV3PrivacyPassword" : "String value",
"snmpV3PrivacyType" : "NONE",
"snmpV3Username" : "String value",
"snmpVersion" : "V1",
"writeCommunity" : "String value"
}
} ]
}
}