A shared network is a network segment to which you assign two or more subnets. When subnets in a shared network contain IP addresses that are available for dynamic allocation, the addresses are put into a common pool for allocation when client requests arise. When you create a shared network, the DHCP server can assign IP addresses to client requests from any subnet (that resides on the same network interface) in the shared network.
References to sharednetwork are object references. The name part of a shared network object reference has the following components:
Example: sharednetwork/5ldHdvcmskMTEuMC4:sharedname
The object cannot be managed on Cloud Platform members.
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): comment, name, network_view, networks.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| networks |
Authority for the shared network.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
authority is associated with the field use_authority (see use flag).
The bootfile name for the shared network. You can configure the DHCP server to support clients that use the boot file name option in their DHCPREQUEST messages.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootfile is associated with the field use_bootfile (see use flag).
The bootserver address for the shared network. You can specify the name and/or IP address of the boot server that the host needs to boot.
The boot server IPv4 Address or name in FQDN format.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootserver is associated with the field use_bootserver (see use flag).
Comment for the shared network, maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
If this field is set to True, the DHCP server generates a hostname and updates DNS with it when the DHCP client request does not contain a hostname.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_generate_hostname is associated with the field use_ddns_generate_hostname (see use flag).
This field controls whether only the DHCP server is allowed to update DNS, regardless of the DHCP clients requests. Note that changes for this field take effect only if ddns_use_option81 is True.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The DNS update Time to Live (TTL) value of a shared network object.
The TTL is a 32-bit unsigned integer that represents the duration, in seconds, for which the update is cached. Zero indicates that the update is not cached.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
Notes
ddns_ttl is associated with the field use_ddns_ttl (see use flag).
By default, the DHCP server does not update DNS when it allocates a fixed address to a client. You can configure the DHCP server to update the A and PTR records of a client with a fixed address. When this feature is enabled and the DHCP server adds A and PTR records for a fixed address, the DHCP server never discards the records.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_update_fixed_addresses is associated with the field use_ddns_update_fixed_addresses (see use flag).
The support for DHCP Option 81 at the shared network level.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_use_option81 is associated with the field use_ddns_use_option81 (see use flag).
If set to true, BOOTP settings are disabled and BOOTP requests will be denied.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
deny_bootp is associated with the field use_deny_bootp (see use flag).
The percentage of the total DHCP utilization of the networks belonging to the shared network multiplied by 1000. This is the percentage of the total number of available IP addresses from all the networks belonging to the shared network versus the total number of all IP addresses in all of the networks in the shared network.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The dhcp_utilization cannot be updated.
dhcp_utilization cannot be written.
A string describing the utilization level of the shared network.
Type
String.
Search
The field is not available for search.
Notes
The dhcp_utilization_status cannot be updated.
dhcp_utilization_status cannot be written.
Determines whether a shared network is disabled or not. When this is set to False, the shared network is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The total number of DHCP leases issued for the shared network.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The dynamic_hosts cannot be updated.
dynamic_hosts cannot be written.
The dynamic DNS updates flag of a shared network object. If set to True, the DHCP server sends DDNS updates to DNS servers in the same Grid, and to external DNS servers.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_ddns is associated with the field use_enable_ddns (see use flag).
Set this to True if you want the DHCP server to use a different lease time for PXE clients.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
If set to true, the client identifier will be ignored.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ignore_client_identifier is associated with the field use_ignore_client_identifier (see use flag).
If this field is set to False, the appliance returns all DHCP options the client is eligible to receive, rather than only the list of options the client has requested.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ignore_dhcp_option_list_request is associated with the field use_ignore_dhcp_option_list_request (see use flag).
Indicates whether the appliance will ignore DHCP client IDs or MAC addresses. Valid values are “NONE”, “CLIENT”, or “MACADDR”. The default is “NONE”.
Type
String.
Create
The default value is NONE.
Search
The field is not available for search.
Notes
ignore_id is associated with the field use_ignore_id (see use flag).
A list of MAC addresses the appliance will ignore.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
An integer that specifies the period of time (in seconds) that frees and backs up leases remained in the database before they are automatically deleted. To disable lease scavenging, set the parameter to -1. The minimum positive value must be greater than 86400 seconds (1 day).
Type
Integer.
Create
The default value is -1.
Search
The field is not available for search.
Notes
lease_scavenge_time is associated with the field use_lease_scavenge_time (see use flag).
This field contains the logic filters to be applied on the this shared network.
This list corresponds to the match rules that are written to the dhcpd configuration file.
Type
A/An Logic Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
logic_filter_rules is associated with the field use_logic_filter_rules (see use flag).
The Microsoft Active Directory user related information.
Type
A/An Active Directory User Data struct.
Search
The field is not available for search.
Notes
The ms_ad_user_data cannot be updated.
ms_ad_user_data cannot be written.
The name of the IPv6 Shared Network.
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
Notes
The name is part of the base object.
The name of the network view in which this shared network resides.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is The default DNS view.
Search
The field is available for search via
Notes
The network_view is part of the base object.
The network_view cannot be updated.
A list of networks belonging to the shared network
Each individual list item must be specified as an object containing a ‘_ref’ parameter to a network reference, for example:
[{
"_ref": "network/ZG5zLm5ldHdvcmskMTAuMwLvMTYvMA",
}]
if the reference of the wanted network is not known, it is possible to specify search parameters for the network instead in the following way:
[{
"_ref": {
'network': '10.0.0.0/8',
}
}]
note that in this case the search must match exactly one network for the assignment to be successful.
Type
A/An network object array.
This field supports nested return fields as described here.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The networks is part of the base object.
The name in FQDN and/or IPv4 Address of the next server that the host needs to boot.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
nextserver is associated with the field use_nextserver (see use flag).
An array of DHCP option structs that lists the DHCP options associated with the object.
Type
A/An DHCP option struct array.
Create
The default value is:
[ { 'name': 'dhcp-lease-time',
'num': 51,
'use_option': False,
'value': '43200',
'vendor_class': 'DHCP'}]
Search
The field is not available for search.
Notes
options is associated with the field use_options (see use flag).
The PXE lease time value of a shared network object. Some hosts use PXE (Preboot Execution Environment) to boot remotely from a server. To better manage your IP resources, set a different lease time for PXE boot requests. You can configure the DHCP server to allocate an IP address with a shorter lease time to hosts that send PXE boot requests, so IP addresses are not leased longer than necessary.
A 32-bit unsigned integer that represents the duration, in seconds, for which the update is cached. Zero indicates that the update is not cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
pxe_lease_time is associated with the field use_pxe_lease_time (see use flag).
The number of static DHCP addresses configured in the shared network.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The static_hosts cannot be updated.
static_hosts cannot be written.
The total number of DHCP addresses configured in the shared network.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The total_hosts cannot be updated.
total_hosts cannot be written.
This field controls whether the DHCP server updates DNS when a DHCP lease is renewed.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
update_dns_on_lease_renewal is associated with the field use_update_dns_on_lease_renewal (see use flag).
Use flag for: authority
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: bootfile
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: bootserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_generate_hostname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_update_fixed_addresses
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_use_option81
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: deny_bootp
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_ddns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ignore_client_identifier
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ignore_dhcp_option_list_request
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ignore_id
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: lease_scavenge_time
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: logic_filter_rules
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: nextserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: options
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| authority | Bool | N | N | N | N/A |
| bootfile | String | N | N | N | N/A |
| bootserver | String | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| ddns_generate_hostname | Bool | N | N | N | N/A |
| ddns_server_always_updates | Bool | N | N | N | N/A |
| ddns_ttl | Unsigned int | N | N | N | N/A |
| ddns_update_fixed_addresses | Bool | N | N | N | N/A |
| ddns_use_option81 | Bool | N | N | N | N/A |
| deny_bootp | Bool | N | N | N | N/A |
| dhcp_utilization | Unsigned int | N | Y | N | N/A |
| dhcp_utilization_status | String | N | Y | N | N/A |
| disable | Bool | N | N | N | N/A |
| dynamic_hosts | Unsigned int | N | Y | N | N/A |
| enable_ddns | Bool | N | N | N | N/A |
| enable_pxe_lease_time | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| ignore_client_identifier | Bool | N | N | N | N/A |
| ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| ignore_id | String | N | N | N | N/A |
| ignore_mac_addresses | [String] | N | N | N | N/A |
| lease_scavenge_time | Integer | N | N | N | N/A |
| logic_filter_rules | [struct] | N | N | N | N/A |
| ms_ad_user_data | struct | N | Y | N | N/A |
| name | String | Y | N | Y | : = ~ |
| network_view | String | N | N | Y | = |
| networks | [obj] | Y | N | Y | N/A |
| nextserver | String | N | N | N | N/A |
| options | [struct] | N | N | N | N/A |
| pxe_lease_time | Unsigned int | N | N | N | N/A |
| static_hosts | Unsigned int | N | Y | N | N/A |
| total_hosts | Unsigned int | N | Y | N | N/A |
| update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| use_authority | Bool | N | N | N | N/A |
| use_bootfile | Bool | N | N | N | N/A |
| use_bootserver | Bool | N | N | N | N/A |
| use_ddns_generate_hostname | Bool | N | N | N | N/A |
| use_ddns_ttl | Bool | N | N | N | N/A |
| use_ddns_update_fixed_addresses | Bool | N | N | N | N/A |
| use_ddns_use_option81 | Bool | N | N | N | N/A |
| use_deny_bootp | Bool | N | N | N | N/A |
| use_enable_ddns | Bool | N | N | N | N/A |
| use_ignore_client_identifier | Bool | N | N | N | N/A |
| use_ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| use_ignore_id | Bool | N | N | N | N/A |
| use_lease_scavenge_time | Bool | N | N | N | N/A |
| use_logic_filter_rules | Bool | N | N | N | N/A |
| use_nextserver | Bool | N | N | N | N/A |
| use_options | Bool | N | N | N | N/A |
| use_pxe_lease_time | Bool | N | N | N | N/A |
| use_update_dns_on_lease_renewal | Bool | N | N | N | N/A |
sharedrecord:a : DNS Shared A record object.
Enter search terms or a module, class or function name.