F5 Payload

Name Mandatory Description Field Type Constraints
name Yes Name of the device. String

  • Accepted special characters: '-' , '_' , '.' , '*' , '|' , '!' and space only.

  • Length 2 - 64 characters.
vendor Yes Vendor of the device - F5. String -
communicationAddressType Yes Communication type to the device. String Possible Values: IP,FQDN.
ip Yes IP of the device. String Required only if communicationAddressType is IP.
fqdn Yes FQDN of the device. String Required only if communicationAddressType is FQDN.
credentialType Yes Type of credential to be associated for the device. String Possible Values: ‘Manual Entry’,"Credential List - AppViewX’,’Credential List - CyberArk’, "Credential List -BeyondTrust".
userName Yes User name of the device. String

Required only if credential Type is Manual entry.

It will not accept ‘,”,<,>.
password Yes Encoded value of the password to authenticate with the device. String Required only if credential Type is Manual entry.
credentialName Yes Name of the credential to be associated with the device. String

  • Required only if credential type is ’Credential List - AppViewX or ’Credential List - CyberArk’.

  • Credential of the requested name should be added in AppViewX already.

  • Accepted special characters: '-' , '_' , '.' , '*' , '|' , '!' and space only.

  • Length 2 - 64 characters.
module Yes Modules with which the device is to be added. String[] Possible Values: LTM, BIG-IP DNS, vCMP Host.
sshPort No Device communication port. String Default value: 22
certSync No Certificate sync mode. String

Possible values: Managed,Monitored,Ignored

Default Value: Ignored.
isAppViewXSyncRequired No Boolean value to denote whether AppViewX group is required. Only for applicable vendors. Boolean Default value: False
isAutoDetectSecondary No Boolean value to denote whether secondary devices should be automatically discovered and added to AppViewX. Boolean Default value: False
tokenBasedAuthentication No Token Based authentication. The possible values are True/False. Boolean -
dataCenter No Data center with which the device is to be added. String

  • Accepted special characters: '-' , '_' , '.' , '*' , '|' , '!' and space only.

  • Length 2 - 64 characters.