Similar to a string element except the contents may be obscured to prevent others from seeing the value.


password <name> [display <display hint>] [required]


  • display - gives a hint to the renderer about how this element should be displayed. This can be “small”, “medium”, “large”, “xlarge”, or “xxlarge”
  • required - if present, then a valid value must be entered.


section example2 {
  string uname required
  password pword required
text {
  example2 "Credentials"
  example2.uname "Please enter username "
  example2.pword "Please enter password "

Resulting UI presentation:

Codeshare Entries

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.