Remove method of the PS_DhcpServerv4FailoverScope class

  • Article

Removes the specified scopes from the failover relationship. For any specified scope which is not part of the specified failover relationship or which do not exist, a NTE will be returned. This processing will be done up front before adding the valid scopes to the failover relationship.

Syntax

uint32 Remove(
  [in]  string               ComputerName,
  [in]  string               Name,
  [in]  string               ScopeId[],
  [in]  boolean              Force,
  [in]  boolean              PassThru,
  [out] DhcpServerv4Failover cmdletOutput
);

Parameters

ComputerName [in]

DNS name or IP address of the target computer running the DHCP server service.

Name [in]

Name of the failover relationships from which the scopes are to be removed.

ScopeId [in]

Scope identifiers, in IPv4 address format, which are to be removed from the failover relationship.

Force [in]

If specified, removes the failover relationship even if the failover relationship is not in Normal state.

PassThru [in]

If this parameter is specified, the cmdlet returns the PowerShell objects which are deleted.

cmdletOutput [out]

An embedded instance of the DhcpServerv4Failover class.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\DHCP
MOF
DhcpServerPsProvider.mof
DLL
DhcpServerPsProvider.dll

See also

PS_DhcpServerv4FailoverScope