hostnamerewritepolicy : Hostname rewrite policy object.

A hostname rewrite policy object represents the set of valid characters as well as replacement characters for names that do not conform to the policy.

Object Reference

References to hostnamerewritepolicy are object references.

The name part of the hostnamerewritepolicy object reference has the following components:

  • The name of the hostname rewrite policy object.
Example:
hostnamerewritepolicy/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:Default

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): name, replacement_character, valid_characters.

The following fields are required to create this object:

Field Notes
name  
replacement_character  
valid_characters  

is_default

is_default

True if the policy is the Grid default.

Type

Bool.

Search

The field is not available for search.

Notes

The is_default cannot be updated.

is_default cannot be written.

name

name

The name of a hostname rewrite policy object.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

pre_defined

pre_defined

Determines whether the policy is a predefined one.

Type

Bool.

Search

The field is not available for search.

Notes

The pre_defined cannot be updated.

pre_defined cannot be written.

replacement_character

replacement_character

The replacement character for symbols in hostnames that do not conform to the hostname policy.

Type

String.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

The replacement_character is part of the base object.

valid_characters

valid_characters

The set of valid characters represented in string format.

Type

String.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

The valid_characters is part of the base object.

Fields List

Field Type Req R/O Base Search
is_default Bool N Y N N/A
name String Y N Y : = ~
pre_defined Bool N Y N N/A
replacement_character String Y N Y N/A
valid_characters String Y N Y N/A