vmod_uuid - Man Page

Prototype

uuid()

Return value

STRING

Description

Returns a uuid version 1 (based on MAC address and the current time)

UUID

set req.http.X-Flow-ID = "cache-" + uuid.uuid();

Prototype

uuid_v1()

Return value

STRING

Description

Returns a uuid version 1. The functions uuid() and uuid_v1() are aliases for one another.

Example

set req.http.X-Flow-ID = "cache-" + uuid.uuid_v1();

Prototype

uuid_v3(STRING namespace, STRING name)

Return value

STRING

Description

Returns a uuid version 3, based on an MD5 hash formed from namespace and name. The namespace argument MUST be one of the following:

• "nil" (for the "nil UUID")
• "ns:DNS" (for the domain name system)
• "ns:URL" (for the URL namespace)
• "ns:OID" (for the ISO object identifier namespace)
• "ns:X500" (for X.500 distinguished names)
• a valid 36-character representation of a UUID, i.e. a string of the form "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", where all of the x's are hex digits, with appropriate restrictions on UUID formats (cf. the RFC)

If these conditions are not met, then uuid_v3() fails; it returns a null string (typically, the header specified in VCL will not be set), and an error message is emitted to the Varnish log with the tag VCL_error.

The name argument can be any string.

Example

set req.http.X-DNS-ID = uuid.uuid_v3("ns:DNS", "www.widgets.com");
set req.http.X-MyNS-ID = uuid.uuid_v3("6ba7b810-9dad-11d1-80b4-00c04fd430c8", "www.widgets.com");

Prototype

uuid_v4()

Return value

STRING

Description

Returns a uuid version 4, based on random numbers.

Example

set req.http.X-Rand-ID = uuid.uuid_v4();

Prototype

uuid_v5(STRING namespace, STRING name)

Return value

STRING

Description

Returns a uuid version 5, based on a SHA1 hash formed from namespace and name. The same restrictions and failure conditions regarding the namespace argument hold as for uuid_v3() above. The name argument can be any string.

Example

set req.http.X-DNS-ID = uuid.uuid_v5("ns:DNS", "www.widgets.com");
set req.http.X-MyNS-ID = uuid.uuid_v5("6ba7b810-9dad-11d1-80b4-00c04fd430c8", "www.widgets.com");