Powerful CLIs to manage your Cloud DNS

Execute a CLI on the TCPWave IPAM.

See changes get reflected in Route 53, Azure etc.

Make a change in Route 53; see TCPWave IPAM getting auto-updated.

TCPWave brings the power of RESTful API via simple CLIs for your Cloud DNS management needs.

TCPWave Command Line Interface

The TCPWave command line interface (CLI) allows you to manage the DNS and DHCP infrastructure from a command line, view status and configuration information, and modify the configuration. Access to the TCPWave IPAM CLI is provided through SSH or direct console access. The TCPWave IPAM CLI requires the administrator to authenticate with the TCPWave IPAM before using any CLIs. A short description of each CLI is listed in the table below. A detailed description of each CLI with helpful examples is provided for the convenience of the end users. The “twc help” CLI provides a list of all the CLIs. The “twc help <cli name>” provides a detailed description and examples for usage. These useful examples simplify the learning curve associated with using the TCPWave IPAM CLIs. For a more detailed CLI reference guide with examples, please contact customercare@tcpwave.com.

An Example

An example of a CLI to add a DNS domain and associate a Change Control Ticket to it’s history is shown below:

tcpwave >> twc adddomain –org=TCPWave –name=”demo.com” –desc=”A Demo Domain added for Change Control CN476894677″

Domain successfully created

List of CLIs in the TCPWave IPAM

Each CLI listed below has an equivalent RestAPI command, which can be invoked after a user authenticates with a token from a pre-assigned source IP Address or a SSL certificate based authentication. The TCPWave CLIs do not support plain text username and passwords as arguments on the CLIs. For additional information and examples to invoke the TCPWave Restful API interface, refer to TCPWave RestAPI.

CommmandDescription
acceptdevicesUpdates the TCPWave IPAM with the discovered objects on a given subnet.
addadminCreates an admin in the TCPWave IPAM.
addadmingroupCreates an admin group in the TCPWave IPAM.
addcontactCreates a contact in the TCPWave IPAM.
addcustomfolderCreates a custom folder in the TCPWave IPAM.
adddhcpoptionCreates a user defined DHCP option in the TCPWave IPAM.
adddnsforwardersCreates a forward only DNS zone on a DNS Server in the TCPWave IPAM.
adddnslogchannelCreates a DNS log channel in the TCPWave IPAM.
adddnsrootzoneCreates a DNS root zone in the TCPWave IPAM.
adddnsviewCreates a DNS view in the TCPWave IPAM.
adddnszoneCreates a DNS Zone in the TCPWave IPAM.
adddnszonetmplCreates a DNS zone template in the TCPWave IPAM.
adddomainCreates a DNS domain in the TCPWave IPAM.
addextCreates an extended attribute in the TCPWave IPAM.
addipv6networkCreates an IPv6 network in the TCPWave IPAM.
addlocationCreates a location in the TCPWave IPAM.
addnetworkCreates a network in the TCPWave IPAM.
addobjectCreates an object in the TCPWave IPAM.
addobjecttypeCreates an object type in the TCPWave IPAM.
addorgCreates an organization in the TCPWave IPAM.
addrrCreates a DNS resource record for a given object in the TCPWave IPAM.
addscopeCreates a DHCP scope in the TCPWave IPAM.
addsubnetCreates a subnet in the TCPWave IPAM.
addsubnetgroupCreates a subnet group in the TCPWave IPAM.
applybinlogLoads the database incremental changes into a recovery database in the TCPWave IPAM.
applydractionApply the specified disaster recovery action in the TCPWave IPAM.
applysnapshotLoads a database snapshot into a recovery database in the TCPWave IPAM.
backupbinlogPerforms a backup of the incremental changes in the TCPWave IPAM.
changepasswordChanges the password of current logged in user in the TCPWave IPAM.
changerootpasswordUpdates root user password for remote DNS/DHCP server.
clearauditClears the audits older than the specified number of days from the TCPWave IPAM.
deleteactiveleaseDeletes the active lease from a DHCP server defined in the TCPWave IPAM.
deleteadminDeletes a admin from the TCPWave IPAM.
deleteadmingroupDeletes an admin group from the TCPWave IPAM.
deletecontactDeletes a contact from the TCPWave IPAM.
deletecustomfolderDeletes a DHCP options custom folder from the TCPWave IPAM.
deletedhcpoptionDeletes a user defined DHCP option from the TCPWave IPAM.
deletedhcpclassDeletes a DHCP Client Class or User Class or Vendor Class from the TCPWave IPAM.
deletedhcpserverDeletes a DHCP Server from the TCPWave IPAM.
deletedhcptempDeletes a DHCP option template or policy template from the TCPWave IPAM.
deletednsaclDeletes a DNS ACL from the TCPWave IPAM.
deletednsforwardersDeletes a forward only zone of a DNS Server from the TCPWave IPAM.
deletednsopttmplDeletes a DNS Option Template from the TCPWave IPAM.
deletednsrootzoneDeletes a DNS root zone from the TCPWave IPAM.
deletednsserverDeletes a DNS Server from the TCPWave IPAM.
deletednsservertmplDeletes a DNS Server Template from the TCPWave IPAM.
deletednsviewDeletes a DNS view from the TCPWave IPAM.
deletednszoneDeletes a DNS Zone from the TCPWave IPAM.
deletednszonetmplDeletes a DNS Zone Template from the TCPWave IPAM.
deletedomainDeletes a DNS Domain from the TCPWave IPAM.
deleteextDeletes an extended attribute from the TCPWave IPAM.
deleteextvalueDeletes the extended attribute value of the specified key defined in the TCPWave IPAM.
deletefirewalltmplDeletes a firewall template from the TCPWave IPAM.
deleteipv6networkDeletes an IPv6 network from the TCPWave IPAM.
deletelocationDeletes a location from the TCPWave IPAM.
deletelogchannelDeletes a DNS log channel from the TCPWave IPAM.
deletenetworkDeletes a network from the TCPWave IPAM.
deleteobjectDeletes an object from the TCPWave IPAM.
deleteobjecttypeDeletes an Object Type from the TCPWave IPAM.
deleteorgDeletes an organization from the TCPWave IPAM.
deleterrDeletes the DNS resource records from the TCPWave IPAM.
deletescopeDeletes a DHCP scope from the TCPWave IPAM.
deletesubnetDeletes a subnet from the TCPWave IPAM.
deletesubnetgroupDeletes a subnet group from the TCPWave IPAM.
disablezonemonitorDisables the monitoring on a given list of zones from the TCPWave IPAM.
discarddiscoveryDiscards the results of a given subnet discovery task from the TCPWave IPAM.
discoverDiscovers a specified element in the TCPWave IPAM.
displayzonedataDisplays the contents of a DNS zone from the TCPWave IPAM.
downloaddhcpconfigDownloads the configuration of a DHCP Server in the TCPWave IPAM.
downloaddnsconfigDownloads the configuration of a DNS Server in the specified zip file in the TCPWave IPAM.
dumpdbCaptures a backup database snapshot from the TCPWave IPAM.
editadminUpdates the profile of the TCPWave IPAM admin.
editadmingroupUpdates an admin group in the TCPWave IPAM.
editcontactUpdates a contact in the TCPWave IPAM.
editcustomfolderUpdates a custom DHCP options folder in the TCPWave IPAM.
editdhcpoptionUpdates a user defined DHCP option in the TCPWave IPAM.
editdnsforwardersUpdates a forward only zone on a DNS Server in the TCPWave IPAM.
editdnsrootzoneUpdates a DNS root zone in the TCPWave IPAM.
editdnsviewUpdates a DNS view in the TCPWave IPAM.
editdnszoneUpdates a DNS Zone in the TCPWave IPAM.
editdnszonetmplUpdates a DNS zone template in the TCPWave IPAM.
editdomainUpdates a DNS domain in the TCPWave IPAM.
editextUpdates an extended attribute in the TCPWave IPAM.
editextvalueUpdates the extended attribute value of specified key's defined in the TCPWave IPAM.
editglobaloptsUpdates a Global Option in the TCPWave IPAM.
editlocationUpdates a location in the TCPWave IPAM.
editlogchannelUpdates a DNS log channel in the TCPWave IPAM.
editnetworkUpdates a network in the TCPWave IPAM.
editobjectUpdates an object in the TCPWave IPAM.
editobjecttypeUpdates an object type in the TCPWave IPAM.
editorgUpdates an organization in the TCPWave IPAM.
editsubnetUpdates a subnet in the TCPWave IPAM.
editsubnetgroupUpdates a subnet group in the TCPWave IPAM.
enablezonemonitorEnables the monitoring on a given list of zones in the TCPWave IPAM.
exportadminExports the admins from the TCPWave IPAM as a csv list into a specified output file.
exportadmingroupExports the admin groups from the TCPWave IPAM to a csv file.
exportadminpermissionExports the admin permissions from the TCPWave IPAM to a csv file.
exportcontactExports the contacts from the TCPWave IPAM to a csv file.
exportdhcpoptiontmplExports the DHCP option templates from the TCPWave IPAM to a name-value pair format file.
exportdhcppolicytmplExports the DHCP policy template from the TCPWave IPAM to a name-value pair format file.
exportdhcpserverExports the DHCP servers from the TCPWave IPAM to a name-value pair format file.
exportdnsaclExports the DNS ACLs from the TCPWave IPAM to a csv file.
exportdnsoptiontmplExports the DNS option templates from the TCPWave IPAM to a name-value pair format file.
exportdnsserverExports the DNS servers from the TCPWave IPAM to a name-value pair format file.
exportdnsservertmplExports the DNS server templates from the TCPWave IPAM to a csv file.
exportdomainExports the DNS domains from the TCPWave IPAM to a csv file.
exportlocationExports the locations from the TCPWave IPAM to a csv file.
exportlogchannelExports the DNS Log Channels from the TCPWave IPAM to a csv file.
exportnetworkExports the networks from the TCPWave IPAM to a csv file.
exportobjectExports the objects from the TCPWave IPAM to a csv file.
exportobjectrrExports the objects resource records from the TCPWave IPAM to a csv file.
exportreversezonetmplExports the network to reverse zone template associations from the TCPWave IPAM to csv file.
exportrevzonerrExports the reverse zone resource records from the TCPWave IPAM to csv file.
exportrrExports the objects resource records of a network or subnet from the TCPWave IPAM to a csv file.
exportscopeExports the scopes from the TCPWave IPAM to a csv file.
exportsubnetExports the subnets from the TCPWave IPAM to a csv file.
exportsubnetdhcpExports the subnet to DHCP Server associations from the TCPWave IPAM to a csv file.
exportsubnetgroupExports the subnet groups from the TCPWave IPAM to a csv file.
exportzoneExports the DNS zones from the TCPWave IPAM to a csv file.
exportzonerrExports the DNS zones resource records from the TCPWave IPAM to a csv file.
exportzonetemplateExports the DNS zone templates from TCPWave IAPM to a csv file.
fetchquerylogFetch the DNS server query logs from the TCPWave IPAM.
getbgpconfigDisplays the BGP configuration of a DNS server from the TCPWave IPAM.
getdhcppolicytempDisplays a DHCP policy template from the TCPWave IPAM.
getdhcpserverDisplays the configuration for a DHCP Server in the TCPWave IPAM.
getdhcptempDisplays the contents of a DHCP option template from the TCPWave IPAM.
getdnsaclDisplays a BIND DNS ACL definition from the TCPWave IPAM.
getdnsdebuglevelDisplays the debug level of a DNS server in the TCPWave IPAM.
getdnsopttmplDisplays the contents of a DNS option template from the TCPWave IPAM.
getdnsserverDisplays the configuration for a DNS Server in the TCPWave IPAM.
getdnsservertmplDisplays the contents of a DNS Server template from the TCPWave IPAM.
getfirewalltmplDisplays the contents of a firewall template from the TCPWave IPAM.
getfreesubnetlistLists all the free subnets within a given network in the TCPWave IPAM.
getnextfreeipDisplays the next available free IP address from a given subnet in the TCPWave IPAM.
getobjectDisplays the contents of an object definition from the TCPWave IPAM.
getsubnetDisplays the details of a given subnet in the TCPWave IPAM.
getzoneDisplays the details of a given zone in the TCPWave IPAM.
importadminImports the admins from a csv file in the TCPWave IPAM.
importadmingroupImports the admin groups from a CSV file into the TCPWave IPAM.
importadminpermissionImports the admin permissions from a CSV file into the TCPWave IPAM.
importcontactImports the contacts from a CSV file into the TCPWave IPAM.
importdhcpoptiontmplImports the DHCP option templates from name-value pair file into the TCPWave IPAM.
importdhcppolicytmplImports the DHCP policy templates from name-value pair file into the TCPWave IPAM.
importdhcpserverImports the DHCP Server from a name-value pair file into the TCPWave IPAM.
importdnsaclImports the DNS ACLs from a CSV file into the TCPWave IPAM.
importdnsoptiontmplImports the DNS Option templates from a name-value pair file into the TCPWave IPAM.
importdnsserverImports the DNS Server from a name-value pair file into the TCPWave IPAM.
importdnsservertmplImports the DNS server templates from a CSV file into the TCPWave IPAM.
importdomainImports the domains from a CSV file into the TCPWave IPAM.
importlocationImports the locations from a CSV file into the TCPWave IPAM.
importlogchannelImports the DNS Log Channels from a CSV file into the TCPWave IPAM.
importnetworkImports the networks from a CSV file into the TCPWave IPAM.
importobjectImports the objects from a CSV file into the TCPWave IPAM.
importobjectrrImports the objects resource records into the TCPWave IPAM.
importptrrecordImports the DNS PTR resource records from a CSV file into the TCPWave IPAM.
importreversezoneImports the DNS reverse zones from a CSV file into the TCPWave IPAM.
importreversezonetmplImports the DNS reverse zones templates from a csv file in the TCPWave IPAM.
importrevzonerrImports the reverse zone resource records from a csv file in the TCPWave IPAM.
importscopeImports the DHCP scopes from a CSV file into the TCPWave IPAM.
importsubnetImports the subnets from a CSV file into the TCPWave IPAM.
importsubnetdhcpImports the subnet to DHCP server associations from a CSV file into the TCPWave IPAM.
importsubnetgroupImports the subnet groups from a CSV file into the TCPWave IPAM.
importzoneImports the DNS zones from a CSV file into the TCPWave IPAM.
importzonerrImports the zone resource records from a csv file into the TCPWave IPAM.
importzonetemplateImports the DNS zone templates from a CSV file into the TCPWave IPAM.
listactiveleaseLists the active leases for a given DHCP server defined in the TCPWave IPAM.
listadminLists the admins defined in the TCPWave IPAM.
listadmingroupLists the admin groups defined in the TCPWave IPAM.
listadminpermissionLists the permissions for a given admin defined in the TCPWave IPAM.
listallpermissionLists the admin permissions for all the users in the TCPWave IPAM.
listpermissionLists the permissions on a given network element defined in the TCPWave IPAM.
listalertsLists the alerts defined in the TCPWave IPAM.
listcustomfolderLists the custom folders defined in the TCPWave IPAM.
listdhcpclassLists the DHCP classes defined in the TCPWave IPAM.
listdhcpoptionLists the user defined DHCP options defined in the TCPWave IPAM.
listdhcpserverLists the DHCP servers defined in the TCPWave IPAM.
listdhcptempLists the DHCP option templates and policy templates defined in the TCPWave IPAM.
listdiscovertaskLists the discovered tasks defined in the TCPWave IPAM.
listdnsaclLists the DNS ACLs defined in the TCPWave IPAM.
listdnsforwardersLists the DNS forward zones of a DNS server defined in the TCPWave IPAM.
listdnsopttmplLists the DNS option templates defined in the TCPWave IPAM.
listdnsserverLists the DNS servers defined in the TCPWave IPAM.
listdnsservertmplLists the DNS servers templates defined in the TCPWave IPAM.
listdnsviewLists the DNS views defined in the TCPWave IPAM.
listdnszoneLists the DNS zones defined in the TCPWave IPAM.
listdnszonetmplLists the DNS zone templates defined in the TCPWave IPAM.
listdomainLists the DNS domains defined in the TCPWave IPAM.
listextLists the extended attributes defined in the TCPWave IPAM.
listextvalueLists the extended attribute values of specified entity defined in the TCPWave IPAM.
listdumpsLists the available database snapshots for recovery defined in the TCPWave IPAM.
listfirewalltmplLists the firewall templates defined in the TCPWave IPAM.
listglobaloptsLists the Global Options defined in the TCPWave IPAM.
listlocationLists the locations defined in the TCPWave IPAM.
listlogchannelLists the DNS log channels defined in the TCPWave IPAM.
listnetworkLists the networks defined in the TCPWave IPAM.
listobjectLists the objects in a given subnet defined in the TCPWave IPAM.
listobjtypeLists the object types defined in the TCPWave IPAM.
listorgLists the organizations defined in the TCPWave IPAM.
listroundrobinLists the DNS round-robins for a given domain defined in the TCPWave IPAM.
listrrLists the resource records in the TCPWave IPAM.
listscopeLists the DHCP scopes defined in the TCPWave IPAM.
listserversforzoneLists the DNS servers for a given zone or zone template defined in the TCPWave IPAM.
listsubnetLists the subnets defined in the TCPWave IPAM.
listsubnetgroupLists the subnet groups defined in the TCPWave IPAM.
listsubnetsforserverLists the subnets associated with a given DHCP Server defined in the TCPWave IPAM.
loginLogin to the TCPWave IPAM server to execute the CLI commands.
mergesubnetMerge the subnets in the TCPWave IPAM.
modpermModifies the permissions in the TCPWave IPAM.
rebuildsearchRebuilds the search indexes and restarts the replicator service in the TCPWave IPAM.
resetdrReset the disaster recovery configuration in the TCPWave IPAM.
restoredbRestores the database from a given snapshot in the TCPWave IPAM.
rptadminauditGenerates an admin audit report to a specified file in the TCPWave IPAM.
rptdeviceutilizationGenerates a device utilization report in three specified files in the TCPWave IPAM.
rptdhcpactiveleaseGenerates a DHCP server active lease report to a specified file the TCPWave IPAM.
rptdhcpdnssvreventsGenerates a DHCP/DNS server event report to a specified file in the TCPWave IPAM.
rptdhcpopttmplauditGenerates a DHCP option template audit report to a specified file in the TCPWave IPAM.
rptdhcppolicytmplauditGenerates a DHCP policy template audit report to a specified file in the TCPWave IPAM.
rptdhcpsvrauditGenerates a DHCP server audit report to a specified file in the TCPWave IPAM.
rptdhcpsvrmanagedsnetGenerates a DHCP server managed subnet audit report to a specified file in the TCPWave IPAM.
rptdhcpoptGenerates a DHCP option report in a pdf file in the TCPWave IPAM.
rptdhcptmplassociationGenerates a DHCP option template association report in specified files in the TCPWave IPAM.
rptdhcptoscopecountGenerates a DHCP Server to scope count report to a specified file in the TCPWave IPAM.
rptdnsopttmplauditGenerates a DNS option template audit report to a specified file in the TCPWave IPAM.
rptdnssoaGenerates a DNS SOA report to a specified file in the TCPWave IPAM.
rptdnssvrauditGenerates a DNS server audit report to a specified file in the TCPWave IPAM.
rptdnssvrtmplauditGenerates a DNS server template audit report to a specified file in the TCPWave IPAM.
rptgloballocbyobjtypeGenerates a global allocation report by object type to a specified file in the TCPWave IPAM.
rptipameventauditGenerates an IPAM events audit report to a specified file in the TCPWave IPAM.
rptloginactivityGenerates a login activity audit report to a specified file in the TCPWave IPAM.
rptmonitoringalertsGenerates a monitoring alert report to a specified file in the TCPWave IPAM.
rptnetauditGenerates a network audit report to a specified file in the TCPWave IPAM.
rptobjauditGenerates an object audit report to a specified file in the TCPWave IPAM.
rptrawdataGenerates a raw data report to a specified file in the TCPWave IPAM.
rptrrauditGenerates a resource record audit report to a specified file in the TCPWave IPAM.
rptschedeventsauditGenerates a scheduled events audit report to a specified file in the TCPWave IPAM.
rptsnetauditGenerates a subnet audit report to a specified file in the TCPWave IPAM.
rptsubnetauditbygroupGenerates a subnet audit report by group to a specified file in the TCPWave IPAM.
rptsubnetlistbygroupGenerates a subnet list report of a subnet group to a specified file in the TCPWave IPAM.
rptsvrconfigauditGenerates a server configuration audit report to a specified file in the TCPWave IPAM.
rpttopalertproducersGenerates a top alerts producers report to a specified file in the TCPWave IPAM.
rptv4netspaceutilGenerates an IPv4 network space utilization audit report to a specified file in the TCPWave IPAM.
rptv4snetspaceutilGenerates an IPv4 subnet space utilization audit report to a specified file in the TCPWave IPAM.
rptzoneauditGenerates a zone audit report to a specified file in the TCPWave IPAM.
rptzonetmplauditGenerates a zone template audit report to a specified file in the TCPWave IPAM.
searchPerforms a search operation in the TCPWave IPAM.
setbgpconfigUpdates BGP configuration of a DNS server in the TCPWave IPAM.
setdhcpclassCreates or updates a DHCP class in the TCPWave IPAM.
setdhcppolicytempCreates or updates a DHCP policy template in the TCPWave IPAM.
setdhcpserverCreates or updates DHCP server configuration in the TCPWave IPAM.
setdhcptempCreates or updates DHCP option template in the TCPWave IPAM.
setdnsaclCreates or updates a DNS ACL in the TCPWave IPAM.
setdnsdebuglevelUpdates the debug level of a DNS server in the TCPWave IPAM.
setdnsopttmplCreates or updates a DNS option template from the TCPWave IPAM.
setdnsserverCreates or updates DNS server configuration in the TCPWave IPAM.
setdnsservertmplCreates or updates a DNS Server template in the TCPWave IPAM.
setfirewalltmplCreates or updates a firewall template in the TCPWave IPAM.
setupdrSetup disaster recovery configuration in the TCPWave IPAM.
showdevicesShows a list of the discovered objects on a subnet in the TCPWave IPAM.
showdrconfigDisplay the disaster recovery configuration in the TCPWave IPAM.
showlicenseShows the license information of the TCPWave IPAM.
splitsubnetSplits a given subnet in the TCPWave IPAM.
syncdhcpserverPerforms a DHCP Server configuration sync with the TCPWave IPAM.
syncdnsserverPerforms a DNS Server full configuration sync with the TCPWave IPAM.
syncobjectSynchronizes an object with master and slave DNS servers in the TCPWave IPAM.
synczonePerforms a DNS zone force sync with the TCPWave IPAM.
updatelicenseUpdates the license with the license key provided by TCPWave Technical Support Team.