nf-dhcpsapi-dhcpv4failovercreaterelationship.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:dhcpsapi.DhcpV4FailoverCreateRelationship	DhcpV4FailoverCreateRelationship function (dhcpsapi.h)	Creates a new DHCPv4 failover relationship between two servers.	DhcpV4FailoverCreateRelationship DhcpV4FailoverCreateRelationship function [DHCP] dhcp.dhcpv4failovercreaterelationship dhcpsapi/DhcpV4FailoverCreateRelationship	dhcp\dhcpv4failovercreaterelationship.htm	DHCP	6e360dd4-b4a0-4652-8754-17c3c284271c	12/05/2018	DhcpV4FailoverCreateRelationship, DhcpV4FailoverCreateRelationship function [DHCP], dhcp.dhcpv4failovercreaterelationship, dhcpsapi/DhcpV4FailoverCreateRelationship	dhcpsapi.h		Windows	None supported	Windows Server 2012 [desktop apps only]										Dhcpsapi.lib	Dhcpsapi.dll		Windows			19H1	DhcpV4FailoverCreateRelationship dhcpsapi/DhcpV4FailoverCreateRelationship	c++	APIRef kbSyntax	DllExport	Dhcpsapi.dll	DhcpV4FailoverCreateRelationship

DhcpV4FailoverCreateRelationship function

-description

The DhcpV4FailoverCreateRelationship function creates a new DHCPv4 failover relationship between two servers.

-parameters

-param ServerIpAddress [in, optional]

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

-param pRelationship [in]

Pointer to a DHCP_FAILOVER_RELATIONSHIP structure that contains information about the DHCPv4 failover relationship to create.

-returns

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.

Value	Meaning
ERROR_INVALID_PARAMETER	One or more of the parameters were invalid.
ERROR_DHCP_SUBNET_NOT_PRESENT	IPv4 scope doesn't exist on the DHCPv4 server.
ERROR_DHCP_FO_SCOPE_ALREADY_IN_RELATIONSHIP	IPv4 is already part of another failover relationship.
ERROR_DHCP_FO_RELATIONSHIP_EXISTS	A failover relationship with the same name already exists on DHCPv4 server.
ERROR_DHCP_FO_RELATIONSHIP_NAME_TOO_LONG	The failover relationship name is longer than the expected length.
ERROR_DHCP_FO_MAX_RELATIONSHIPS	The maximum number of allowed failover relationship configured on the DHCP server has exceeded.

-see-also

DhcpV4FailoverDeleteRelationship

DhcpV4FailoverEnumRelationship

DhcpV4FailoverGetRelationship

DhcpV4FailoverSetRelationship