SOLIDserver API Reference Guide

Version 5.0.4
SOLIDserver API Reference Guide
SOLIDserver API Reference Guide
Revision: #50575

Publication date August 25, 2015

Copyright © 2000-2015 EfficientIP
All specifications and information regarding the products in this document are subject to change without notice and should not be
construed as a commitment by EfficientIP. EfficientIP assumes no responsibility or liability for any mistakes or inaccuracies that may
appear in this document. All statements and recommendations in this document are believed to be accurate but are presented without
warranty. Users must take full responsibility for their application of any product.
Table of Contents
About this Guide ............................................................................................................. xiii
Documentation Organization .................................................................................... xiii
Documentation Convention ...................................................................................... xiii
I. SOAP ............................................................................................................................ 1
1. Introduction ........................................................................................................... 3
Prerequisites .................................................................................................... 3
Limitations ........................................................................................................ 3
2. Technical Overview ................................................................................................ 4
3. Custom WSDL File Configuration ........................................................................... 5
Browsing the WSDL Database ........................................................................... 5
Creating and Using a Custom WSDL File ........................................................... 6
Deleting a Custom WSDL File ............................................................................ 7
Editing and Dumping a Custom WSDL File ......................................................... 7
Downloading a Custom WSDL File ..................................................................... 9
4. SOAP Client Example .......................................................................................... 11
5. Frequently Asked Questions ................................................................................. 12
II. REST .......................................................................................................................... 13
6. Introduction ......................................................................................................... 15
Prerequisites .................................................................................................. 15
Limitations ...................................................................................................... 15
7. Technical Overview .............................................................................................. 16
Service Execution Based on HTTP Verbs ......................................................... 16
REST Calls Format and Description ................................................................. 16
RPC Calls Format and Description ................................................................... 18
8. REST Client Example .......................................................................................... 19
9. Frequently Asked Questions ................................................................................. 20
III. IPAM Services ............................................................................................................ 21
10. Space ............................................................................................................... 25
ip_site_add ..................................................................................................... 26
ip_site_count .................................................................................................. 28
ip_site_list ...................................................................................................... 29
ip_site_info ..................................................................................................... 31
ip_site_admin_group_count ............................................................................. 33
ip_site_admin_group_list ................................................................................. 34
ip_site_admin_service_count ........................................................................... 36
ip_site_admin_service_list ............................................................................... 37
group_site_add ............................................................................................... 38
group_site_delete ........................................................................................... 39
ip_site_delete ................................................................................................. 40
11. IPv4 Block ......................................................................................................... 41
ip_block_add .................................................................................................. 42
ip_block_count ................................................................................................ 44
ip_block_list .................................................................................................... 45
ip_block_info ................................................................................................... 48
ip_block_subnet_count .................................................................................... 51
ip_block_subnet_list ........................................................................................ 53
ip_block_class_list .......................................................................................... 57
ip_block_admin_group_count ........................................................................... 58
ip_block_admin_group_list ............................................................................... 59
ip_block_admin_service_count ........................................................................ 61
ip_block_admin_service_list ............................................................................ 62

iii
 SOLIDserver API Reference Guide

group_block_add ............................................................................................. 63
group_block_delete ......................................................................................... 64
ip_block_delete ............................................................................................... 65
12. IPv6 Block ......................................................................................................... 66
ip6_block6_add ............................................................................................... 67
ip6_block6_count ............................................................................................ 69
ip6_block6_list ................................................................................................ 70
ip6_block6_info ............................................................................................... 73
ip6_block6_subnet6_count .............................................................................. 76
ip6_block6_subnet6_list ................................................................................... 77
ip6_block6_class_list ....................................................................................... 81
ip6_block6_admin_group_list ........................................................................... 82
ip6_block6_admin_service_list ......................................................................... 83
group_block6_add ........................................................................................... 84
group_block6_delete ....................................................................................... 85
ip6_block6_delete ........................................................................................... 86
13. IPv4 Subnet ...................................................................................................... 87
ip_subnet_add ................................................................................................ 88
ip_subnet_count ............................................................................................. 91
ip_subnet_list .................................................................................................. 92
ip_subnet_info ................................................................................................ 96
ip_subnet_address_count ................................................................................ 99
ip_subnet_address_list .................................................................................. 100
ip_free_subnet_count .................................................................................... 101
ip_free_subnet_list ........................................................................................ 102
ip_find_free_subnet ....................................................................................... 103
ip_subnet_class_list ...................................................................................... 104
ip_subnet_admin_group_count ...................................................................... 105
ip_subnet_admin_group_list .......................................................................... 106
ip_subnet_admin_service_count .................................................................... 108
ip_subnet_admin_service_list ........................................................................ 109
group_subnet_add ........................................................................................ 110
group_subnet_delete ..................................................................................... 111
ip_subnet_delete ........................................................................................... 112
14. IPv6 Subnet ..................................................................................................... 114
ip6_subnet6_add ........................................................................................... 115
ip6_subnet6_count ........................................................................................ 117
ip6_subnet6_list ............................................................................................ 118
ip6_subnet6_info ........................................................................................... 122
ip6_subnet6_address_count .......................................................................... 125
ip6_subnet6_address_list .............................................................................. 126
ip6_used_subnet6_address_count ................................................................. 127
ip6_used_subnet6_address_list ..................................................................... 128
ip6_used_subnet6_address_info .................................................................... 132
ip6_find_free_subnet6 ................................................................................... 135
ip6_free_subnet6_count ................................................................................ 136
ip6_free_subnet6_list .................................................................................... 137
ip6_subnet6_class_list ................................................................................... 138
ip6_subnet6_admin_group_list ....................................................................... 139
ip6_subnet6_admin_service_list ..................................................................... 140
group_subnet6_add ...................................................................................... 141
group_subnet6_delete ................................................................................... 142
ip6_subnet6_delete ....................................................................................... 143
15. IPv4 Pool ......................................................................................................... 145

iv
 SOLIDserver API Reference Guide

ip_pool_add .................................................................................................. 146

ip_pool_count ............................................................................................... 148
ip_pool_list ................................................................................................... 149
ip_pool_name_list ......................................................................................... 152
ip_pool_info .................................................................................................. 153
ip_pool_class_list .......................................................................................... 156
ip_pool_admin_group_count .......................................................................... 157
ip_pool_admin_group_list .............................................................................. 159
ip_pool_admin_service_count ........................................................................ 161
ip_pool_admin_service_list ............................................................................ 162
group_pool_add ............................................................................................ 163
group_pool_delete ......................................................................................... 164
ip_pool_delete .............................................................................................. 165
16. IPv6 Pool ......................................................................................................... 167
ip6_pool6_add .............................................................................................. 168
ip6_pool6_count ............................................................................................ 170
ip6_pool6_list ................................................................................................ 171
ip6_pool6_info ............................................................................................... 174
ip6_pool6_name_list ...................................................................................... 177
ip6_pool6_class_list ...................................................................................... 178
group_pool6_add .......................................................................................... 179
group_pool6_delete ....................................................................................... 180
ip6_pool6_delete ........................................................................................... 181
17. IPv4 Address ................................................................................................... 183
ip_add .......................................................................................................... 184
ip_address_count .......................................................................................... 186
ip_address_list .............................................................................................. 187
ip_address_info ............................................................................................. 192
ip_find_free_address ..................................................................................... 196
ip_free_ip_count ........................................................................................... 197
ip_free_ip_list ................................................................................................ 198
ip_used_subnet_address_count ..................................................................... 199
ip_used_subnet_address_list ......................................................................... 200
ip_used_subnet_address_info ........................................................................ 205
ip_delete ....................................................................................................... 209
18. IPv6 Address ................................................................................................... 211
ip6_address6_add ......................................................................................... 212
ip6_address6_count ...................................................................................... 214
ip6_address6_list .......................................................................................... 216
ip6_address6_info ......................................................................................... 220
ip6_find_free_address6 ................................................................................. 221
ip6_free_ip6_count ........................................................................................ 222
ip6_free_ip6_list ............................................................................................ 223
ip6_used_subnet6_address_count ................................................................. 224
ip6_used_subnet6_address_list ..................................................................... 225
ip6_used_subnet6_address_info .................................................................... 229
ip6_address6_delete ..................................................................................... 232
19. IPv4 Address Alias ........................................................................................... 234
ip_alias_add ................................................................................................. 235
ip_alias_list ................................................................................................... 236
ip_alias_delete .............................................................................................. 237
20. IPv6 Address Alias ........................................................................................... 238
ip6_alias_add ................................................................................................ 239
ip6_alias_list ................................................................................................. 240

v
 SOLIDserver API Reference Guide

ip6_alias_delete ............................................................................................ 241

IV. DHCP Services ........................................................................................................ 242
21. DHCPv4 Server ............................................................................................... 247
dhcp_add ..................................................................................................... 248
dhcp_server_count ........................................................................................ 251
dhcp_server_list ............................................................................................ 252
dhcp_server_info ........................................................................................... 256
dhcp46_server46_count ................................................................................ 259
dhcp46_server46_list .................................................................................... 260
dhcp46_server46_info ................................................................................... 264
dhcp_server_options_list ............................................................................... 267
dhcp_server_admin_group_count .................................................................. 268
dhcp_server_admin_group_list ....................................................................... 269
dhcp_server_admin_service_count ................................................................ 271
dhcp_server_admin_service_list .................................................................... 272
group_dhcp_add ........................................................................................... 273
group_dhcp_delete ........................................................................................ 274
dhcp_delete .................................................................................................. 275
22. DHCPv6 Server ............................................................................................... 276
dhcp6_add .................................................................................................... 277
dhcp6_server6_count .................................................................................... 279
dhcp6_server6_list ........................................................................................ 280
dhcp6_server6_info ....................................................................................... 283
dhcp46_server46_count ................................................................................ 286
dhcp46_server46_list .................................................................................... 287
dhcp46_server46_info ................................................................................... 291
dhcp6_server6_options6_list .......................................................................... 294
dhcp6_server6_admin_group_count ............................................................... 295
dhcp6_server6_admin_group_list ................................................................... 296
dhcp6_server6_admin_service_count ............................................................. 298
dhcp6_server6_admin_service_list ................................................................. 299
group_dhcp6_add ......................................................................................... 300
group_dhcp6_delete ...................................................................................... 301
dhcp6_delete ................................................................................................ 302
23. DHCPv4 Group ................................................................................................ 303
dhcp_group_add ........................................................................................... 304
dhcp_group_count ......................................................................................... 306
dhcp_group_list ............................................................................................. 307
dhcp_group_info ........................................................................................... 309
dhcp_group_options_list ................................................................................ 310
dhcp_group_delete ........................................................................................ 311
24. DHCPv6 Group ................................................................................................ 312
dhcp6_group6_add ....................................................................................... 313
dhcp6_group6_count ..................................................................................... 315
dhcp6_group6_list ......................................................................................... 316
dhcp6_group6_info ........................................................................................ 318
dhcp6_group6_options6_list .......................................................................... 319
dhcp6_group6_delete .................................................................................... 320
25. DHCPv4 Scope ............................................................................................... 321
dhcp_scope_add ........................................................................................... 322
dhcp_scope_count ........................................................................................ 324
dhcp_scope_list ............................................................................................ 325
dhcp_scope_info ........................................................................................... 328
dhcp_scope_options_list ................................................................................ 330

vi
 SOLIDserver API Reference Guide

dhcp_scope_admin_group_count ................................................................... 331

dhcp_scope_admin_group_list ....................................................................... 332
dhcp_scope_admin_service_count ................................................................. 334
dhcp_scope_admin_service_list ..................................................................... 335
group_dhcpscope_add .................................................................................. 336
group_dhcpscope_delete ............................................................................... 337
dhcp_scope_delete ....................................................................................... 338
26. DHCPv6 Scope ............................................................................................... 339
dhcp6_scope6_add ....................................................................................... 340
dhcp6_scope6_count .................................................................................... 342
dhcp6_scope6_list ........................................................................................ 343
dhcp6_scope6_info ....................................................................................... 346
dhcp6_scope6_options6_list .......................................................................... 348
dhcp6_scope6_admin_group_count ............................................................... 349
dhcp6_scope6_admin_group_list ................................................................... 350
dhcp6_scope6_admin_service_count ............................................................. 352
dhcp6_scope6_admin_service_list ................................................................. 353
group_dhcpscope6_add ................................................................................ 354
group_dhcpscope6_delete ............................................................................. 355
dhcp6_scope6_delete ................................................................................... 356
27. DHCPv4 Shared Network ................................................................................. 357
dhcp_sn_add ................................................................................................ 358
dhcp_shared_network_count ......................................................................... 360
dhcp_shared_network_list ............................................................................. 361
dhcp_shared_network_info ............................................................................ 363
28. DHCPv6 Shared Network ................................................................................. 364
dhcp6_sn6_add ............................................................................................ 365
dhcp6_shared_network6_count ...................................................................... 367
dhcp6_shared_network6_list .......................................................................... 368
dhcp6_shared_network6_info ........................................................................ 370
29. DHCPv4 Range ............................................................................................... 371
dhcp_range_add ........................................................................................... 372
dhcp_range_count ......................................................................................... 374
dhcp_range_list ............................................................................................. 375
dhcp_range_info ........................................................................................... 378
dhcp_range_options_list ................................................................................ 381
dhcp_range_delete ........................................................................................ 382
30. DHCPv6 Range ............................................................................................... 384
dhcp6_range6_add ....................................................................................... 385
dhcp6_range6_count ..................................................................................... 387
dhcp6_range6_list ......................................................................................... 388
dhcp6_range6_info ........................................................................................ 391
dhcp6_range6_options6_list .......................................................................... 393
dhcp6_range6_delete .................................................................................... 394
31. DHCPv4 Lease ................................................................................................ 395
dhcp_range_lease_count ............................................................................... 396
dhcp_range_lease_list ................................................................................... 397
dhcp_range_lease_info .................................................................................. 400
dhcp_lease_log_count ................................................................................... 403
dhcp_lease_log_list ....................................................................................... 404
dhcp_lease_delete ........................................................................................ 406
dhcp_lease_manual_delete ........................................................................... 407
32. DHCPv6 Lease ................................................................................................ 408
dhcp6_lease6_count ..................................................................................... 409

vii
 SOLIDserver API Reference Guide

dhcp6_lease6_list ......................................................................................... 410

dhcp6_lease6_info ........................................................................................ 413
dhcp6_lease6_log_count ............................................................................... 416
dhcp6_lease6_log_list ................................................................................... 417
dhcp6_lease6_delete .................................................................................... 419
dhcp6_lease6_manual_delete ........................................................................ 420
33. DHCPv4 Static ................................................................................................. 421
dhcp_static_add ............................................................................................ 422
dhcp_static_count ......................................................................................... 425
dhcp_static_list ............................................................................................. 426
dhcp_static_info ............................................................................................ 429
dhcp_static_options_list ................................................................................. 432
dhcp_static_delete ........................................................................................ 433
34. DHCPv6 Static ................................................................................................. 435
dhcp6_static6_add ........................................................................................ 436
dhcp6_static6_count ...................................................................................... 439
dhcp6_static6_list .......................................................................................... 440
dhcp6_static6_info ........................................................................................ 443
dhcp6_static6_options6_list ........................................................................... 445
dhcp6_static6_delete ..................................................................................... 446
35. DHCPv4 Options ............................................................................................. 448
dhcp_option_add ........................................................................................... 449
36. DHCPv6 Options ............................................................................................. 452
dhcp6_option6_add ....................................................................................... 453
37. DHCPv4 Optiondef .......................................................................................... 456
dhcp_optiondef_add ...................................................................................... 457
dhcp_optiondef_count ................................................................................... 459
dhcp_optiondef_list ....................................................................................... 460
dhcp_optiondef_info ...................................................................................... 462
dhcp_optiondef_delete .................................................................................. 463
38. DHCPv6 Optiondef .......................................................................................... 464
dhcp6_optiondef6_add .................................................................................. 465
dhcp6_optiondef6_count ................................................................................ 467
dhcp6_optiondef6_list .................................................................................... 468
dhcp6_optiondef6_info .................................................................................. 470
dhcp6_optiondef6_delete ............................................................................... 471
39. DHCPv4 ACL and ACL Entries ......................................................................... 472
dhcp_acl_add ............................................................................................... 473
dhcp_acl_delete ............................................................................................ 475
dhcp_acl_data_add ....................................................................................... 476
dhcp_acl_data_delete ................................................................................... 478
dhcp_class_count ......................................................................................... 479
dhcp_class_list ............................................................................................. 480
dhcp_class_info ............................................................................................ 482
dhcp_class_options_list ................................................................................. 483
dhcp_subclass_count .................................................................................... 484
dhcp_subclass_list ........................................................................................ 485
dhcp_subclass_info ....................................................................................... 487
dhcp_subclass_options_list ............................................................................ 488
40. DHCPv4 Failover ............................................................................................. 489
dhcp_failover_add ......................................................................................... 490
dhcp_failover_count ...................................................................................... 492
dhcp_failover_list ........................................................................................... 493
dhcp_failover_server_list ............................................................................... 495

viii
 SOLIDserver API Reference Guide

dhcp_failover_info ......................................................................................... 496

dhcp_failover_set_partner_down .................................................................... 498
dhcp_failover_delete ...................................................................................... 499
41. DHCPv6 Failover ............................................................................................. 500
dhcp6_failover6_add ..................................................................................... 501
dhcp6_failover6_count ................................................................................... 503
dhcp6_failover6_list ....................................................................................... 504
dhcp6_failover6_server6_list .......................................................................... 506
dhcp6_failover6_info ...................................................................................... 507
dhcp6_failover6_delete .................................................................................. 508
V. DNS Services ............................................................................................................ 509
42. DNS Server ..................................................................................................... 512
dns_add ....................................................................................................... 513
dns_server_count .......................................................................................... 516
dns_server_list .............................................................................................. 517
dns_server_info ............................................................................................ 521
dns_options_add ........................................................................................... 524
dns_server_param_add ................................................................................. 526
dns_server_param_count .............................................................................. 527
dns_server_param_list .................................................................................. 528
dns_server_param_info ................................................................................. 530
dns_server_param_delete ............................................................................. 531
dns_send_rndc ............................................................................................. 532
group_dns_add ............................................................................................. 533
group_dns_delete ......................................................................................... 534
dns_server_admin_group_count .................................................................... 535
dns_server_admin_group_list ........................................................................ 536
dns_server_admin_service_count .................................................................. 538
dns_server_admin_service_list ...................................................................... 539
dns_delete .................................................................................................... 540
43. DNS ACL ........................................................................................................ 541
dns_acl_add ................................................................................................. 542
dns_acl_count ............................................................................................... 543
dns_acl_list ................................................................................................... 544
dns_acl_info ................................................................................................. 546
dns_acl_delete .............................................................................................. 547
44. TSIG Key ......................................................................................................... 548
dns_key_add ................................................................................................ 549
dns_key_count .............................................................................................. 551
dns_key_list .................................................................................................. 552
dns_key_info ................................................................................................. 554
dns_key_delete ............................................................................................. 555
45. View ................................................................................................................ 556
dns_view_add ............................................................................................... 557
dns_view_count ............................................................................................ 559
dns_view_list ................................................................................................ 560
dns_view_info ............................................................................................... 562
dns_view_param_add .................................................................................... 564
dns_view_param_count ................................................................................. 565
dns_view_param_list ..................................................................................... 566
dns_view_param_info .................................................................................... 568
dns_view_param_delete ................................................................................ 569
dns_view_admin_group_count ....................................................................... 570
dns_view_admin_group_list ........................................................................... 571

ix
 SOLIDserver API Reference Guide

dns_view_admin_service_count ..................................................................... 573

dns_view_admin_service_list ......................................................................... 574
group_dnsview_add ...................................................................................... 575
group_dnsview_delete ................................................................................... 576
dns_view_delete ........................................................................................... 577
46. Zone ............................................................................................................... 578
dns_zone_add .............................................................................................. 579
dns_zone_count ............................................................................................ 581
dns_zone_list ................................................................................................ 582
dns_zone_info ............................................................................................... 586
dns_zone_param_add ................................................................................... 590
dns_zone_param_count ................................................................................ 591
dns_zone_param_list .................................................................................... 592
dns_zone_param_info ................................................................................... 594
dns_zone_param_delete ............................................................................... 595
dns_zone_admin_group_count ...................................................................... 596
dns_zone_admin_group_list .......................................................................... 597
dns_zone_admin_service_count .................................................................... 599
dns_zone_admin_service_list ........................................................................ 600
group_dnszone_add ...................................................................................... 601
group_dnszone_delete .................................................................................. 602
dns_zone_delete ........................................................................................... 603
47. Resource Record ............................................................................................. 604
dns_rr_add ................................................................................................... 605
dns_rr_count ................................................................................................. 608
dns_rr_info .................................................................................................... 609
dns_rr_list ..................................................................................................... 611
dns_rr_delete ................................................................................................ 614
48. DNSSEC ......................................................................................................... 616
macro_sign_dnssec_zones_php .................................................................... 617
dnssec_link_anchor ....................................................................................... 619
dnssec_trust_anchor_count ........................................................................... 620
dnssec_trust_anchor_list ............................................................................... 621
dnssec_trust_anchor_info .............................................................................. 623
dnssec_unlink_anchor ................................................................................... 625
VI. NetChange Services ................................................................................................. 626
49. Network Device ............................................................................................... 628
iplnetdev_count ............................................................................................. 629
iplnetdev_list ................................................................................................. 630
iplnetdev_info ................................................................................................ 632
group_iplnetdev_add ..................................................................................... 634
group_iplnetdev_delete .................................................................................. 635
iplocator_netdev_delete ................................................................................. 636
50. VLAN .............................................................................................................. 637
iplnetdevvlan_count ....................................................................................... 638
iplnetdevvlan_list ........................................................................................... 639
51. Port ................................................................................................................. 641
iplocator_port_add ........................................................................................ 642
iplport_count ................................................................................................. 643
iplport_list ..................................................................................................... 644
iplport_info .................................................................................................... 646
52. Discovered Item ............................................................................................... 648
ipldev_count ................................................................................................. 649
ipldev_list ...................................................................................................... 650

x
 SOLIDserver API Reference Guide

ipldev_log_count ........................................................................................... 654

ipldev_log_list ............................................................................................... 655
VII. Workflow Services ................................................................................................... 659
workflow_request_add ........................................................................................... 660
request_incoming_count ........................................................................................ 663
request_incoming_list ............................................................................................ 664
request_outgoing_count ........................................................................................ 665
request_outgoing_list ............................................................................................ 666
request_info .......................................................................................................... 667
workflow_request_delete ....................................................................................... 668
VIII. Administration Services ........................................................................................... 669
53. Services Management ..................................................................................... 671
service_list .................................................................................................... 672
group_service_add ........................................................................................ 674
group_service_delete .................................................................................... 675
54. Group ............................................................................................................. 676
group_add .................................................................................................... 677
group_count .................................................................................................. 679
group_list ...................................................................................................... 680
group_info .................................................................................................... 682
maintainer_group_list .................................................................................... 684
group_admin_user_count .............................................................................. 685
group_admin_user_list .................................................................................. 686
group_admin_item_count ............................................................................... 688
group_admin_item_list ................................................................................... 689
group_admin_count ....................................................................................... 691
group_admin_list ........................................................................................... 692
group_admin_info .......................................................................................... 694
group_admin_service_list .............................................................................. 696
group_delete ................................................................................................. 697
55. User ................................................................................................................ 698
user_add ...................................................................................................... 699
user_modify_password .................................................................................. 701
user_modify_settings ..................................................................................... 702
user_info ...................................................................................................... 703
user_admin_count ......................................................................................... 705
user_admin_list ............................................................................................. 706
user_admin_info ............................................................................................ 708
user_admin_group_list .................................................................................. 710
user_service_list ........................................................................................... 711
group_service_list ......................................................................................... 712
group_user_add ............................................................................................ 713
group_user_delete ........................................................................................ 714
user_delete ................................................................................................... 715
56. Custom Database and Custom Data ................................................................. 716
custom_db_name_add .................................................................................. 717
custom_db_name_count ................................................................................ 718
custom_db_name_list .................................................................................... 719
custom_db_name_info .................................................................................. 721
custom_db_name_delete ............................................................................... 722
custom_db_data_add .................................................................................... 723
custom_db_data_count ................................................................................. 724
custom_db_data_list ...................................................................................... 725
custom_db_data_delete ................................................................................. 727

xi
 SOLIDserver API Reference Guide

57. Class .............................................................................................................. 728

class_add ..................................................................................................... 729
class_list ....................................................................................................... 730
class_count .................................................................................................. 732
group_class_add ........................................................................................... 733
group_class_delete ....................................................................................... 734
class_delete .................................................................................................. 735
A. Return Codes ............................................................................................................ 736

xii
About this Guide
SOLIDserver can be managed using web services instead of or in addition to the GUI. Since
version 5.0.4, you can managed the web services via two different methods:

• SOAP protocol.
• REST mechanism.

This guide provides an overview of both and a description of the services that both methods allow
to execute.

Documentation Organization
This guide includes the following parts:

• SOAP: provides an introduction to SOAP, the creation of custom WSDL files from SOLIDserver
GUI, a client example and set of frequently asked questions.
• REST: provides an introduction to REST and RPC, a client example and set of frequently asked
questions.
• IPAM Services: details the IP address management dedicated services. It includes: Spaces,
Blocks, Subnets, Pools and IP addresses.
• DHCP Services: details the DHCP management dedicated services. It includes: DHCP servers,
DHCP scopes, DHCP groups, DHCP ranges, DHCP statics and DHCP options.
• DNS Services: details the DNS management dedicated services. It includes: DNS servers,
DNS views, DNS zones, DNS resource records and DNS options.
• NetChange Services: details the NetChange dedicated services. It includes: network devices,
VLAN, ports and discovered items.
• Workflow Services: details the Workflow dedicated services. It includes: requests.
• Administration Services: details the services dedicated to the management of rights and
delegations through groups and users. It also includes all the services dedicated to Custom
DB.

At the end of the guide, you will find in appendix:

• Return codes that lists in a table all the return codes may they be errors, warnings or notices.

Documentation Convention
Within the service dedicated parts, every service is detailed as follows:

Table 1. Style conventions

Convention Description
Name The service name and purpose
Description Extra information regarding the service.
Input parameters The parameters that you can use in input when calling the service.
Output parameters The parameters returned in output, once the service is executed.

xiii
Part I. SOAP
Table of Contents
1. Introduction ................................................................................................................... 3
Prerequisites ............................................................................................................ 3
Limitations ................................................................................................................ 3
2. Technical Overview ........................................................................................................ 4
3. Custom WSDL File Configuration ................................................................................... 5
Browsing the WSDL Database ................................................................................... 5
Creating and Using a Custom WSDL File ................................................................... 6
Deleting a Custom WSDL File .................................................................................... 7
Editing and Dumping a Custom WSDL File ................................................................. 7
Downloading a Custom WSDL File ............................................................................. 9
4. SOAP Client Example .................................................................................................. 11
5. Frequently Asked Questions ......................................................................................... 12

2
Chapter 1. Introduction
The Simple Object Access Protocol (SOAP) is a protocol specification that allows you to exchange
structured information and implement web services. You can use it to execute SOLIDserver web
services instead of, or in addition to, managing them through the graphical user interface. Almost
all the operations available in the GUI can be performed using web services: creations, editions,
deletions, retrieval of information... In addition, the WSDL technology allows you to create scripts
that execute several services one after the other.

SOAP has many advantages:

• Quick development of scripts with WSDL technology and the code generator.
• Do several operations at once.
• Automating and planning tasks.
• Create your own management interface.

SOLIDserver SOAP web services has been tested with the following languages/packages :

• PHP: PHP5 SOAP Extension (NuSOAP, and PEAR SOAP are not officially supported).
• C#: You will need the .Net Framework version 3.5 at least, but we recommend versions 4.0 /
4.5 as they both use the WCF framework.
• Perl: SOAP::Lite.
• Python: SOAPpy.
• C/C++: gSOAP and Axis (RPC/Encoded).
• Microsoft C# with .Net Framework.
• Ruby: SOAP::WSDLDriver.
• Java: Axis2.

Prerequisites
• Any call requires the following user authentication parameters:
1. auth_login: the login of the user account used to query services. This user is a SOLIDserver
user.
2. auth_password: the password of the user account. This password can be held by SOLID-
server or by an external directory as LDAP, RADIUS or Microsoft Active Directory.

Make sure the user has sufficient rights and permissions to execute the service. For more details,
refer to the part Right Management of SOLIDserver Administrator Guide.
• The whole transaction has to be done using HTTPS.

If you query the web server through HTTP, the Apache server returns the error message 302
– Page has moved, and if your framework does not handle that correctly the call will fail.

Limitations
• SOAP allows you to execute the services one by one. Any specific options and settings that
are automated through the GUI have to be specified when executing the services via SOAP.

3
Chapter 2. Technical Overview
SOAP uses a prototyping language that describes the supported calls and their parameters: the
Web Services Description Language (WSDL) file. This file is often used by SOAP frameworks
to map their client class and know which functions can be called. You can either link your class
directly to the WSDL file located on the server https://<ip_address>/interfaces/wsdl_eip_full.wsdl
or store it locally to improve performances and reduce the bandwidth usage. This WSDL file is
generated every time the ipmserver process is started: during SOLIDserver initial boot or any
rebooting. Keep in mind that you can restart ipmserver (SOLIDserver) through a shell connection
using the following command: /usr/local/etc/rc.d/ipmserver.sh restart. Depending on your frame-
work, you could also use a non-WSDL mode but in that case you would have to map everything
by yourself. This operation is not in the scope of this document.

This WSDL file is generated using all descriptive XML files located in the directory /usr/loc-
al/nessy2/www/php/interfaces/xml/. The WSDL file list the input and output parameters of each
and every functions supported. If you want to call a custom macro or script, you will need the
correct XML file in that directory to make sure that they are recognized by SOLIDserver. To be
able to use new parameters, you simply need to update the XML file (although this step is not
required most of the time).

This WSDL File can be generated from the GUI, as detailed in the following section.

4
Chapter 3. Custom WSDL File
Configuration
To help you in the configuration of WSDL Files, you can use SOLIDserver dedicated page of the
Administration module. As SOAP relies on WSDL files, we recommend that you use the custom
WSDL wizard to create the file as it assists you in your configuration: it provides an auto-completion
field that recognizes the services name you start typing in. For more details regarding each service,
please refer to the IPAM, DHCP, DNS and Administration parts of this guide.

From the GUI, you will be able to create, edit, download and delete WSDL files. Once created
through the GUI you will be able to use the files to call the services they contain.

Browsing the WSDL Database

Within the Administration module, the Local Files Listing page contains a page dedicated to
WSDL Files: Custom WSDL.

To display the WSDL Files

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).
2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The set of columns changes.

To display the content of a WSDL file

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).
2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The set of columns changes.
5. Click on the name of the WSDL file of your choice. A new page appears and displays all the
services that the file contains in the column Service name.

The Custom WSDL contains a specific set of columns:

Table 3.1. Custom WSDL Columns

Column Description
Name Displays the entry name. Clicking on the name will
Endpoint Displays the chosen Endpoint upon file creation.
Creation date Displays the file creation time and date.

5
 Custom WSDL File Configuration

Column Description
Dump date Displays the file dump time and date.
Status Displays the file status: Dumped, Modified since dump, IP doesn't
exist or Dumping in progress.

Creating and Using a Custom WSDL File

From SOLIDserver Administration module you can create as many WSDL files as you need. The
WSDL files will be saved in the custom_wsdl directory as follows: <WSDL-file-name>.wsdl which
is why you do not need to fill the extension when creating the file.

To create a custom WSDL file through SOLIDserver GUI

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).
2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The set of columns changes.
5. In the menu, select Add > WSDL File. The Add a custom WSDL file wizard opens.

Figure 3.1. Example of a custom WSDL file creation

a. In the field WSDL file name, name the file. No need to add the .wsdl extension.
b. In the drop-down list WSDL EndPoint, select the EndPoint of your choice: it can be the
Hostname or an IP address. This EndPoint will be used in the return.
c. In the field Service name, type in the first letters of a service or module: the auto-com-
pletion will provide a list of all the services partially matching this name.
d. Select the service of your choice and click on ADD . The service name is moved to the
list Selected services. Repeat these actions for as many services as you want.

6
 Custom WSDL File Configuration

To update an entry, select a service, edit the service name and use the auto-completion
suggestions to choose a different service and click on UPDATE .

To delete an entry, select a service and click on DELETE .

To discard the latest modifications, click on CANCEL .

6. Click on OK to commit the creation of the WSDL file. The report opens and closes. The files
is listed on the page and saved in the custom_wsdl directory.

Once you generated your custom WSDL file, it is automatically dumped: you can use the services
you listed in the WSDL file no matter what programming language you use.

To use the services listed in the WSDL file you just created, you need to integrate to your
source code the location of your WSDL file within SOLIDserver database using its absolute
address : https://<ip_address>/interfaces/custom_wsdl/<your-WSDL-fil-name>.wsdl .

Deleting a Custom WSDL File

At any time, you can delete a Custom WSDL file if no longer require using it

To delete a custom WSDL file

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).
2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The WSDL dedicated columns appear.
5. Tick the file(s) you want to delete.
6. In the menu, select Edit >Delete file(s). The Delete file wizard opens.
7. Click on OK to commit the deletion. The report opens and closes. The file is no longer listed.

Editing and Dumping a Custom WSDL File

At any point, you can edit a WSDL file content that is to say add or remove services.

Warning
If you edit a WSDL file, you need to dump it again.

You can add as many services as you want to a WSDL file. When adding the services, you can
dump your file.

To add services to a custom WSDL file

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).

7
 Custom WSDL File Configuration

2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The WSDL dedicated columns appear.
5. Click on the name of the file you want to edit. A new page appears, its lists all the file services.
6. In the menu, select Add > Service. The Add a service wizard opens.
7. In the field Service name, type in the first letters of a service or module: the auto-completion
will provide a list of all the services partially matching this name.
8. Select the service of your choice and click on ADD . The service name is moved to the list
Selected services. Repeat these actions for as many services as you want.

To update an entry, select a service, edit the service name and use the auto-completion
suggestions to choose a different service and click on UPDATE .

To delete an entry, select a service and click on DELETE .

To discard the latest modifications, click on CANCEL .

9. If you want to dump the WSDL file upon edition, tick the Dump WSDL file(s) box.
10. Click on OK to commit your changes. The report opens and closes. The new services are
listed.
11. To go back to the list of WSDL files, under the menu, tick the bullet Custom WSDL. The
WSDL files are listed.

If you ticked the Dump WSDL file(s) box the file Status is Dumped. The file is updated and
can be used immediately.

If you did not tick the Dump WSDL file(s) box the file Status is Modified since dump. The file
content needs to be dumped to be up-to-date.

You can remove as many services as you want from a WSDL file. When removing services, you
can dump your file.

To remove services from a custom WSDL file

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).
2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The WSDL dedicated columns appear.
5. Click on the name of the file you want to edit. A new page appears, its lists all the file services.
6. Tick the service(s) you want to remove from the list.
7. In the menu, select Edit > Delete a service from a WSDL file. The wizard Delete service
opens.
8. If you want to dump the WSDL file upon edition, tick the Dump WSDL file(s) box. The drop-
down list WSDL EndPoint opens.

8
 Custom WSDL File Configuration

• In the drop-down list WSDL EndPoint, you can select the EndPoint of your choice
(hostname or IP address). By default, the WSDL file current Endpoint is selected, you
can leave it or choose a different one.

9. Click on OK to commit your changes. The report opens and closes. The services are no
longer listed.
10. To go back to the list of WSDL files, under the menu, tick the bullet Custom WSDL. The
WSDL files are listed.

If you ticked the Dump WSDL file(s) box the file Status is Dumped. The file is updated and
can be used immediately.

If you did not tick the Dump WSDL file(s) box the file Status is Modified since dump. The file
content needs to be dumped to be up-to-date.

If you edited the content of a file but chose not to dump it upon edition, you can still dump its
content and even change its Endpoint if need be.

To dump a custom WSDL file

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).
2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The WSDL dedicated columns appear.
5. In the column Name, filter the list if need be.
6. Tick the file(s) you want to dump.
7. In the menu, select Tools > Dump WSDL File(s). The Dump WSDL file(s) wizard opens.
8. Via the checkbox Change Endpoint, you can edit the file(s) endpoint. Follow the steps below
to do so or go to step 9 to simply dump the file.

a. Tick the box. A drop-down list appears.

b. In the drop-down list WSDL EndPoint , select the EndPoint of your choice (hostname
or IP address).

9. Click on OK to commit your configuration. The report opens and closes. The files are marked
as Dumped. If you edited the EndPoint, the new value is visible.

Downloading a Custom WSDL File

You can at any time download a WSDL file.

To download a custom WSDL file

1. Connect to SOLIDserver using the super user credentials (login: ipmadmin and password:
admin).

9
 Custom WSDL File Configuration

2. Go to the Administration tab. If the homepage is not displayed, click on . The homepage
opens.
3. In the menu, select Maintenance > Local Files listing. The Local files listing page opens.
By default, it displays the list Local is displayed.
4. Under the menu, select the Custom WSDL bullet. The WSDL dedicated columns appear.
5. In the column Name, filter the list if need be.
6. Tick the file(s) you want to dump.
7. In the menu, select Tools > Dump in Local Files Listing. The wizard opens and closes. The
file is now listed in the Local page of the Local Files Listing.
8. Under the menu, tick the bullet Local. The list Local opens.
9. In the list, the WSDL is listed as follows: <WSDL-file-name>.tar.
10. Click on the file name to download it.

10
Chapter 4. SOAP Client Example
To perform SOAP queries you can use a programming language that implements a SOAP
framework or an equivalent. The following script file explains the basics of SOAP queries as well
as how the parameters should be provided.
<?php
/*
* This is a SOAP client example using the PHP SOAP API.
* It executes the service "ip_block_subnet_list" to retrieve
* all the blocks/subnets in the space "Local".
*/

/*
* If the certificate used by SOLIDserver is self-signed, you might need to create
* this kind of stream context:
*/
$context = stream_context_create(array(
'ssl' => array(
'verify_peer' => false,
'verify_peer_name' => false,
'allow_self_signed' => true
)
));

/*
* The SOAP API is only available with HTTPS.
* Replace "solid.intranet" with the IP/Hostname of your SOLIDserver.
*/
$client = new SoapClient('https://solid.intranet/interfaces/wsdl_eip_full.wsdl', array('stream_context'
=> $context));

/*
* Parameters used to execute the service.
*/
$struct = array('auth_login' => 'ipmadmin',
'auth_password' => 'admin',
'WHERE' => "site_name LIKE 'Local'");
$ret = $client->ip_block_subnet_list($struct);

foreach ($ret as $entry)

echo 'Subnet #',$entry->subnet_id,' is ',$entry->subnet_name,"\n";

11
Chapter 5. Frequently Asked Questions
1. The script was not able to parse the WSDL file

• If you got an answer containing JavaScript from the server.

It is likely that the credentials were either not provided in the script or invalid.
• If you have a WSDL file but the validation failed.

It might be linked to trash data located in the /xml/ directory. Make sure that no filename
starts with a '.' (dot) or contains a tilde (~), a hash sign (#) or an at sign (@).
• Make sure that the whole exchange is using HTTPS and not HTTP.

2. The client could not connect to the server

• Make sure that your SOLIDserver appliance has a correct hostname and that it can be
resolved using a DNS query for the SOAP client.
• Make sure that both machines can see each other (ping, …) and that no firewall rule pre-
vents the communication.

3. I called a function containing a specific parameter but it was ignored

It is likely that the XML file describing the function is missing the parameter in question, which
is why it looks like it is ignoring it. Make sure the parameter is specified in input.

If you had to edit the XML file, restart the IPMserver process to generate a new WSDL file.
4. A listing function is missing output parameters

It is likely that the XML file describing the function is missing output parameters. Make sure
that all the expected parameters are specified in output.

If you had to edit the XML file, restart the IPMserver process to generate a new WSDL file.

12
Part II. REST
Table of Contents
6. Introduction ................................................................................................................. 15
Prerequisites .......................................................................................................... 15
Limitations .............................................................................................................. 15
7. Technical Overview ...................................................................................................... 16
Service Execution Based on HTTP Verbs ................................................................. 16
REST Calls Format and Description ......................................................................... 16
RPC Calls Format and Description ........................................................................... 18
8. REST Client Example .................................................................................................. 19
9. Frequently Asked Questions ......................................................................................... 20

14
Chapter 6. Introduction
The Representational State Transfer (REST) is a software architectural style that applies to
components, connectors and data elements within a distributed hypermedia system. It allows to
set up guidelines that implement web services. These guidelines contain a set of constraints -
HTTP verbs - that ignore the details of component implementation and protocol syntax to focus
on the components role, their interaction with other components and their interpretation of signi-
ficant data elements.

SOLIDserver supports a REST-like architectural style based on basic HTTP/1.1 verbs mapped
to CRUD operations (Create, Read, Update and Delete). To execute web services using REST,
keep in mind that the operations available are not RESTful nor HATEOAS. You can use REST
mechanism to execute SOLIDserver web services instead of, or in addition to, managing them
through the graphical user interface. Almost all the operations available in the GUI can be per-
formed using web services: creations, editions, deletions, retrieval of information... You can also
integrate a succession of services in a script. REST presents the following advantages:

• Execution of CRUD services in a URL style.

• Automating and planning tasks.

In addition, SOLIDserver supports the Remote Procedure Call (RPC), a network protocol that
allows you to execute complex services or macros, which input and output parameters are detailed
in a script. RPC presents the following advantages:

• Execution of a RPC-style script containing macros or one or several complex services para-
meters.
• Automating and planning tasks.

Prerequisites
• SOLIDserver version 5.0.4 and higher.
• Any call requires user authentication, the credentials must be in base64 format.

Make sure the user has sufficient rights to execute the service.
• If you use a browser based REST client and kept the default SSL certificate, you need to accept
SOLIDserver GUI certificate before executing the web services.

Limitations
• SOLIDserver only accepts five HTTP verbs. For more details, refer to the chapter Technical
Overview.
• REST calls must respect the HTTP/1.1 format. Calls respecting HTTP/1.0 are not interpreted
by the Apache server.

15
Chapter 7. Technical Overview
Both REST and RPC support 5 HTTP-verbs and request payload, when relevant.

They use different formatting approach to reach the same goal: executing SOLIDserver web
services. Which is why, we divided this chapter as follows:

1. Accepted HTTP verbs.

2. REST calls format, expected input and output.
3. RPC calls format, expected input and output.

Service Execution Based on HTTP Verbs

Both REST-like architectural style and RPC support 5 HTTP-verbs:

• POST to create resources. Calls using that verb are not idempotent.

Service type: *_add.

• GET to retrieve resource information. Calls using that verb are idempotent.

Service type: *_info, *_list, *_count, *_groupby.

• PUT to update resources. Calls using that verb are idempotent.

Service type: *_add.

• DELETE to delete resources. Calls using that verb are idempotent.

Service type: *_delete.

• OPTIONS to retrieve a service help details. Calls using that verb are idempotent.

Service type: any service.

Any other verb will return an HTTP error: 501 - Method Not Implemented, 405- Method Not Allowed
or 400 - Bad Request.

In addition, you can send a request payload to send a more detailed service execution. For more
details, refer to the sections below.

REST Calls Format and Description

Any REST call must respect the following URL format: https://<SOLIDserver-IP-ad-
dress>/rest/<service-name>, where:

• https is the only way to execute the service. Typing in http:// returns an error 302.
• <SOLIDserver-IP-address> is the IP address used to connect to your appliance.The appliance
must be running, you must have connected to SOLIDserver GUI at least once and accepted
the SSL certificate.
• rest specifies the method used to execute the service and indicates the expected input para-
meters format.
• <service-name> is the name of the SOLIDserver service to be executed.

16
 Technical Overview

No matter what service you execute:

• You must execute the service with the appropriate HTTP verb, the service returns an error
otherwise.
• You must specify user credentials, this user must be granted sufficient rights and resources
to execute the service, in the following format:
X-IPM-Username: <SOLIDserver-user-login-in-base64-format>
X-IPM-Password: <SOLIDserver-user-password-in-base64-format>

For calls that do not require input parameters, to request a list for instance, you can follow the
procedure below if you use a REST client to execute our services.

To execute a service without input via a REST GUI client

1. Open your REST GUI client.

2. In the URL field type in https://<SOLIDserver-IP-address>/rest/<service-name> .
3. Select the appropriate HTTP verb: POST, GET, PUT, DELETE or OPTIONS .
4. In the Headers, type in the user credentials X-IPM-Username: <base64-login> and X-IPM-
Password: <base64-password> as detailed above.
5. Send the request.

The URL format can also be used to execute more complex services. In which case, you must:

• Specify the parameter and value following one of these formats:

• https://<SOLIDser ver-IP-address>/rest/<ser vice-name>/<param1>/<param1-
value>/<param2>/<param2-value>/...
• https://<SOLIDser ver-IP-address>/rest/<ser vice-name>?<param1>=<param1-
value>&<param2>=<param2-value>/...
• Use an URL that respects the formatting of HTTP/1.1.
• Respect the HTTP URL-encoding when specifying the parameters' value.

Do not hesitate to use a script that includes the service input parameters needed rather than
converting every parameter value in URL encoding format. This script can also include several
services as well.

REST Calls With Payload

Any service executed with POST or PUT can be sent with a request payload. It allows to send
a more detailed the service execution, with a specific ID, name or option for instance.

The payload must be JSON formatted. It can be included in a script.

It is useless, and therefore not possible, to send a request payload for calls using GET, DELETE
and OPTIONS.

REST Calls Expected Response

After the service is executed:

• A service execution response is sent with an HTTP status or error code.

17
 Technical Overview

• The service returns the output parameters in JSON format.

RPC Calls Format and Description

Any RPC call must respect the following format: https://<SOLIDserver-IP-address>/rpc/<service-
or-macro-name>, where:

• https is the only way to execute the service. Typing in http:// returns an error 302.
• <SOLIDserver-IP-address> is the IP address used to connect to your appliance.The appliance
must be running, you must have connected to SOLIDserver GUI at least once and accepted
the SSL certificate.
• rpc specifies the method used to execute the service and indicates the expected input para-
meters format.
• <service-name> is the name of the SOLIDserver service to be executed.

An RPC services execution is detailed in a script that must include:

• The URL format line detailed above, specifying the IP address, method and service.
• A service execution using the verb POST. No other HTTP verb is allowed.
• The service or macro parameters in the payload. It must be JSON formatted.

Here is an example of the content of an RPC script used to sign DNS zones:
HTTP/1.1 POST https://<SOLIDserver-IP-address>/rpc/macro_sign_dnssec_zones.php
X-IPM-Username: aXBtYWRtaW4=
X-IPM-Password: YWRtaW4=

// specify the parameters in the payload

{"zsk_encryption_type":"rsa","<param2>":"<param2-value>",[...]}

RPC Calls Expected Response

After the service is executed:

• A service execution response is sent with an HTTP status or error code.

• The service returns the output parameters in JSON format.

18
Chapter 8. REST Client Example
To perform REST requests you can use a programming language that implements a REST
framework or an equivalent. The following script file explains the basics of such request.
<?php
/*
* This is a REST client example using the PHP cURL API.
* It executes the service "ip_block_subnet_list" to retrieve
* all the blocks and subnets in the space "Local".
*/

/*
* The URL that executes the service.
* Replace "solid.intranet" with the IP/Hostname of your SOLIDserver.
*/
$service_url = 'https://solid.intranet/rest/ip_block_subnet_list/WHERE/'.urlencode("site_name='Local'");
$ch = curl_init($service_url);

/*
* The service "ip_block_subnet_list" is executed with a request GET.
*/
curl_setopt_array($ch, array(CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_HTTPGET => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array('X-IPM-Username: aXBtYWRtaW4=', // "ipmadmin" in base64
'X-IPM-Password: YWRtaW4='), // "admin" in base64
// Depending on the kind of certificate you installed on your SOLIDserver,
// you might need to set the two options below.
CURLOPT_SSL_VERIFYHOST => 0,
CURLOPT_SSL_VERIFYPEER => false));
$response = curl_exec($ch);
$http_code = curl_getinfo($ch,CURLINFO_HTTP_CODE);
curl_close($ch);

echo "Service: ",$service_url,"\n";

echo "HTTP code: ",$http_code,"\n";
// The response is in JSON format
echo "Response: ",$response,"\n";

19
Chapter 9. Frequently Asked Questions
1. The value of an input parameter contains a "/", how do I format the call ?

To make sure your call is properly executed if an input parameter's value contains a "/" you
need to use the basic URI format to write down the URL.

Instead of calling the web service with the format https://<IP-address>/rest/<service-

name>/<param>/<value>/..., you must use the format https://<IP-address>/rest/<service-
name>?<param>=<value>&... .
2. The client could not connect to the server

• Make sure that your SOLIDserver appliance has a correct hostname and that it can be
resolved using a DNS query for the SOAP client.
• Make sure that your SOLIDserver responses to ping requests.

20
Part III. IPAM Services
Table of Contents
10. Space ....................................................................................................................... 25
ip_site_add ............................................................................................................. 26
ip_site_count .......................................................................................................... 28
ip_site_list .............................................................................................................. 29
ip_site_info ............................................................................................................. 31
ip_site_admin_group_count ..................................................................................... 33
ip_site_admin_group_list ......................................................................................... 34
ip_site_admin_service_count ................................................................................... 36
ip_site_admin_service_list ....................................................................................... 37
group_site_add ....................................................................................................... 38
group_site_delete ................................................................................................... 39
ip_site_delete ......................................................................................................... 40
11. IPv4 Block ................................................................................................................. 41
ip_block_add .......................................................................................................... 42
ip_block_count ........................................................................................................ 44
ip_block_list ............................................................................................................ 45
ip_block_info ........................................................................................................... 48
ip_block_subnet_count ............................................................................................ 51
ip_block_subnet_list ................................................................................................ 53
ip_block_class_list .................................................................................................. 57
ip_block_admin_group_count ................................................................................... 58
ip_block_admin_group_list ....................................................................................... 59
ip_block_admin_service_count ................................................................................ 61
ip_block_admin_service_list .................................................................................... 62
group_block_add ..................................................................................................... 63
group_block_delete ................................................................................................. 64
ip_block_delete ....................................................................................................... 65
12. IPv6 Block ................................................................................................................. 66
ip6_block6_add ....................................................................................................... 67
ip6_block6_count .................................................................................................... 69
ip6_block6_list ........................................................................................................ 70
ip6_block6_info ....................................................................................................... 73
ip6_block6_subnet6_count ...................................................................................... 76
ip6_block6_subnet6_list ........................................................................................... 77
ip6_block6_class_list ............................................................................................... 81
ip6_block6_admin_group_list ................................................................................... 82
ip6_block6_admin_service_list ................................................................................. 83
group_block6_add ................................................................................................... 84
group_block6_delete ............................................................................................... 85
ip6_block6_delete ................................................................................................... 86
13. IPv4 Subnet .............................................................................................................. 87
ip_subnet_add ........................................................................................................ 88
ip_subnet_count ..................................................................................................... 91
ip_subnet_list .......................................................................................................... 92
ip_subnet_info ........................................................................................................ 96
ip_subnet_address_count ........................................................................................ 99
ip_subnet_address_list .......................................................................................... 100
ip_free_subnet_count ............................................................................................ 101
ip_free_subnet_list ................................................................................................ 102
ip_find_free_subnet ............................................................................................... 103
ip_subnet_class_list .............................................................................................. 104

22
 IPAM Services

ip_subnet_admin_group_count .............................................................................. 105

ip_subnet_admin_group_list .................................................................................. 106
ip_subnet_admin_service_count ............................................................................ 108
ip_subnet_admin_service_list ................................................................................ 109
group_subnet_add ................................................................................................ 110
group_subnet_delete ............................................................................................. 111
ip_subnet_delete ................................................................................................... 112
14. IPv6 Subnet ............................................................................................................. 114
ip6_subnet6_add ................................................................................................... 115
ip6_subnet6_count ................................................................................................ 117
ip6_subnet6_list .................................................................................................... 118
ip6_subnet6_info ................................................................................................... 122
ip6_subnet6_address_count .................................................................................. 125
ip6_subnet6_address_list ...................................................................................... 126
ip6_used_subnet6_address_count ......................................................................... 127
ip6_used_subnet6_address_list ............................................................................. 128
ip6_used_subnet6_address_info ............................................................................ 132
ip6_find_free_subnet6 ........................................................................................... 135
ip6_free_subnet6_count ........................................................................................ 136
ip6_free_subnet6_list ............................................................................................ 137
ip6_subnet6_class_list ........................................................................................... 138
ip6_subnet6_admin_group_list ............................................................................... 139
ip6_subnet6_admin_service_list ............................................................................. 140
group_subnet6_add .............................................................................................. 141
group_subnet6_delete ........................................................................................... 142
ip6_subnet6_delete ............................................................................................... 143
15. IPv4 Pool ................................................................................................................. 145
ip_pool_add .......................................................................................................... 146
ip_pool_count ....................................................................................................... 148
ip_pool_list ........................................................................................................... 149
ip_pool_name_list ................................................................................................. 152
ip_pool_info .......................................................................................................... 153
ip_pool_class_list .................................................................................................. 156
ip_pool_admin_group_count .................................................................................. 157
ip_pool_admin_group_list ...................................................................................... 159
ip_pool_admin_service_count ................................................................................ 161
ip_pool_admin_service_list .................................................................................... 162
group_pool_add .................................................................................................... 163
group_pool_delete ................................................................................................. 164
ip_pool_delete ...................................................................................................... 165
16. IPv6 Pool ................................................................................................................. 167
ip6_pool6_add ...................................................................................................... 168
ip6_pool6_count .................................................................................................... 170
ip6_pool6_list ........................................................................................................ 171
ip6_pool6_info ....................................................................................................... 174
ip6_pool6_name_list .............................................................................................. 177
ip6_pool6_class_list .............................................................................................. 178
group_pool6_add .................................................................................................. 179
group_pool6_delete ............................................................................................... 180
ip6_pool6_delete ................................................................................................... 181
17. IPv4 Address ........................................................................................................... 183
ip_add .................................................................................................................. 184
ip_address_count .................................................................................................. 186
ip_address_list ...................................................................................................... 187

23
 IPAM Services

ip_address_info ..................................................................................................... 192

ip_find_free_address ............................................................................................. 196
ip_free_ip_count ................................................................................................... 197
ip_free_ip_list ........................................................................................................ 198
ip_used_subnet_address_count ............................................................................. 199
ip_used_subnet_address_list ................................................................................. 200
ip_used_subnet_address_info ................................................................................ 205
ip_delete ............................................................................................................... 209
18. IPv6 Address ........................................................................................................... 211
ip6_address6_add ................................................................................................. 212
ip6_address6_count .............................................................................................. 214
ip6_address6_list .................................................................................................. 216
ip6_address6_info ................................................................................................. 220
ip6_find_free_address6 ......................................................................................... 221
ip6_free_ip6_count ................................................................................................ 222
ip6_free_ip6_list .................................................................................................... 223
ip6_used_subnet6_address_count ......................................................................... 224
ip6_used_subnet6_address_list ............................................................................. 225
ip6_used_subnet6_address_info ............................................................................ 229
ip6_address6_delete ............................................................................................. 232
19. IPv4 Address Alias ................................................................................................... 234
ip_alias_add ......................................................................................................... 235
ip_alias_list ........................................................................................................... 236
ip_alias_delete ...................................................................................................... 237
20. IPv6 Address Alias ................................................................................................... 238
ip6_alias_add ........................................................................................................ 239
ip6_alias_list ......................................................................................................... 240
ip6_alias_delete .................................................................................................... 241

24
Chapter 10. Space

25
 Space

Name
ip_site_add — Add/Edit a space
Description
The service ip_site_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
site_description
Space description.
parent_site_id
The parent_site_id parameter is the Space parent identifier (ID) used to join foreign data.
This identifier is a unique numeric key value that is automatically incremented.
parent_site_name
Space parent name.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
root_site_id
Root space ID in the IP address hierarchy.
hidden_site
Hidden site.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.

26
 Space

add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.
site_is_template
Space is a template.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

27
 Space

Name
ip_site_count — Number of spaces
Description
The service ip_site_count count the number of spaces in the database. To execute this service,
users must be granted permission to use it.

The rows returned to the user running the service depend on the resources granted to the group
they belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: site_is_template, is_terminal, site_id, tree_level,

tree_path, tree_id_path, site_is_default, site_name, site_description, parent_site_id, par-
ent_site_name, site_class_name, site_class_parameters, row_enabled, site_custom1,
site_custom2, site_custom3, hidden_site, root_site_id, real_site_id, real_site_name,
real_tree_level.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

28
 Space

Name
ip_site_list — List the spaces
Description
The service ip_site_list allows to list entries from SOLIDserver database. To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: site_is_template, is_terminal, site_id, tree_level,

tree_path, tree_id_path, site_is_default, site_name, site_description, parent_site_id, par-
ent_site_name, site_class_name, site_class_parameters, row_enabled, site_custom1,
site_custom2, site_custom3, hidden_site, root_site_id, real_site_id, real_site_name,
real_tree_level.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
site_is_template
Space is a template.
is_terminal
Subnet6 is terminal.

29
 Space

site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
tree_level
Depth of imbricated spaces.
tree_id_path
Not documented.
site_is_default
Not documented.
site_name
site name.
site_description
Space description.
parent_site_id
The parent_site_id parameter is the Space parent identifier (ID) used to join foreign data.
This identifier is a unique numeric key value that is automatically incremented.
parent_site_name
Space parent name.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
root_site_id
Root space ID in the IP address hierarchy.

30
 Space

Name
ip_site_info — Display the properties of a space
Description
The service ip_site_info returns information regarding the space specified in the input, here the
parameter site_id.

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
site_is_template
Space is a template.
is_terminal
Subnet6 is terminal.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
tree_level
Depth of imbricated spaces.
tree_id_path
Not documented.
site_is_default
Not documented.
site_name
site name.
site_description
Space description.
parent_site_id
The parent_site_id parameter is the Space parent identifier (ID) used to join foreign data.
This identifier is a unique numeric key value that is automatically incremented.
parent_site_name
Space parent name.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.

31
 Space

site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
root_site_id
Root space ID in the IP address hierarchy.

32
 Space

Name
ip_site_admin_group_count — Total number of groups that can access the space
list

Description
The service ip_site_admin_group_count allows to display the total number of groups of users
that can access the space list. The rows returned to the user running the service are not subject
to the group resources, this service returns data as if the user running it belonged to the admin
group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

33
 Space

Name
ip_site_admin_group_list — List all the groups that can access the space list
Description
The service ip_site_admin_group_list allows to list entries from SOLIDserver database. The rows
returned to the user running the service are not subject to the group resources, this service returns
data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.

34
 Space

grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

35
 Space

Name
ip_site_admin_service_count — Total number of rights for a group to add/delete
IPv4 objects in spaces

Description
The service ip_site_admin_service_count allows to display the total number of rights for a group
of users to add/delete IPv4 objects in a space. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

36
 Space

Name
ip_site_admin_service_list — List all the rights of a group to add/delete IPv4 objects
in spaces

Description
The service ip_site_admin_service_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

37
 Space

Name
group_site_add — Add a space as group resource
Description
The service group_site_add allows to add an object as resource for a group of users. You must
specify the group of users and the object that you set as resource. Once set as a resource, the
group can manage the object according to the rights (services) it has access to.

To execute this service, users must be granted permission to use the service group_site_add.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
site_id
The space identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
site_name
The space name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

38
 Space

Name
group_site_delete — Remove a space from a group resources
Description
The service group_site_delete allows to delete SOLIDserver database object. The service
group_site_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
site_id
The space identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
site_name
The space name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

39
 Space

Name
ip_site_delete — Delete a space
Description
The service ip_site_delete allows to delete spaces from the database. Users of the admin group
can delete any object. Standard users, can only delete objects listed among their group resources,
if and only if their group is allowed to execute the service. If you do not have sufficient rights to
execute the service, refer to the part Rights Management of the Administrator Guide, in the
chapter Managing Groups.

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

40
Chapter 11. IPv4 Block

41
 IPv4 Block

Name
ip_block_add — Add/Edit an IPv4 block
Description
The service ip_block_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_name
The IPv4 block name.
block_addr
Block start IP address.
block_end_addr
Block end IP address.
block_size
Block size.
block_prefix
Block prefix.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
block_class_parameters
The block_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by block_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
block_level
Block level.

42
 IPv4 Block

keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

43
 IPv4 Block

Name
ip_block_count — Number of IPv4 blocks
Description
The service ip_block_count allows to display the number of IPv4 blocks.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block_path, type, top_tree_level, block_level, block_id,
vlsm_subnet_id, block_custom1, block_custom2, block_custom3, block_class_name,
block_sort_name, real_site_id, site_is_template, site_name, real_tree_level, real_tree_path,
block_name, scope_size, block_size, block_type, block_description, start_ip_addr,
end_ip_addr, block_start_ip_addr, block_end_ip_addr, used_percent, allocated_percent,
scope_size_allocated, scope_size_used, vlsm_site_id, vlsm_site_name, parent_site_id,
block_class_parameters, site_description, site_class_name, site_class_parameters,
row_enabled, site_custom1, site_custom2, site_custom3, block_start_ip_addr,
block_end_ip_addr, tree_path, tree_level, site_id, hidden_site, real_hidden_site,
real_site_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

44
 IPv4 Block

Name
ip_block_list — List the IPv4 blocks
Description
The service ip_block_list allows to list entries from SOLIDserver database. To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block_path, type, top_tree_level, block_level, block_id,
vlsm_subnet_id, block_custom1, block_custom2, block_custom3, block_class_name,
block_sort_name, real_site_id, site_is_template, site_name, real_tree_level, real_tree_path,
block_name, scope_size, block_size, block_type, block_description, start_ip_addr,
end_ip_addr, block_start_ip_addr, block_end_ip_addr, used_percent, allocated_percent,
scope_size_allocated, scope_size_used, vlsm_site_id, vlsm_site_name, parent_site_id,
block_class_parameters, site_description, site_class_name, site_class_parameters,
row_enabled, site_custom1, site_custom2, site_custom3, block_start_ip_addr,
block_end_ip_addr, tree_path, tree_level, site_id, hidden_site, real_hidden_site,
real_site_name.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

45
 IPv4 Block

block_path
Block path.
top_tree_level
Not documented.
block_level
Block6 level.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
site_is_template
Space is a template.
site_name
site name.
block_name
The IPv4 block name.
scope_size
Size of the container either it is a block or a subnet.
block_size
Block size.
block_type
Block type.
block_description
Not documented.
start_ip_addr
First IP address of the range.
end_ip_addr
Last IP address of the range.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
used_percent
Not documented.
allocated_percent
Percentage of allocated subnets just below the container.
scope_size_allocated
Number of allocated subnets just below the container.
scope_size_used
Number of IP addresses used in a subnet.

46
 IPv4 Block

vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID) used to join foreign data. This
identifier is a unique numeric key value that is automatically incremented.
vlsm_site_name
VLSM space name.
parent_site_id
The parent_site_id parameter is the Space parent identifier (ID) used to join foreign data.
This identifier is a unique numeric key value that is automatically incremented.
block_class_parameters
The block_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by block_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
tree_level
Depth of imbricated spaces.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

47
 IPv4 Block

Name
ip_block_info — Display the properties of an IPv4 block
Description
The service ip_block_info returns the information on the object specified in input.

Input Parameters
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
block_path
Block path.
top_tree_level
Not documented.
block_level
Block6 level.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
site_is_template
Space is a template.
site_name
site name.
block_name
The IPv4 block name.
scope_size
Size of the container either it is a block or a subnet.
block_size
Block size.
block_type
Block type.
block_description
Not documented.

48
 IPv4 Block

start_ip_addr
First IP address of the range.
end_ip_addr
Last IP address of the range.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
used_percent
Not documented.
allocated_percent
Percentage of allocated subnets just below the container.
scope_size_allocated
Number of allocated subnets just below the container.
scope_size_used
Number of IP addresses used in a subnet.
vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID) used to join foreign data. This
identifier is a unique numeric key value that is automatically incremented.
vlsm_site_name
VLSM space name.
parent_site_id
The parent_site_id parameter is the Space parent identifier (ID) used to join foreign data.
This identifier is a unique numeric key value that is automatically incremented.
block_class_parameters
The block_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by block_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

49
 IPv4 Block

row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
tree_level
Depth of imbricated spaces.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

50
 IPv4 Block

Name
ip_block_subnet_count — Number of IPv4 blocks and subnets
Description
The service ip_block_subnet_count allows to display the number of IPv4 blocks and subnets.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block_subnet_id, type, subnet_id, start_ip_addr,

end_ip_addr, subnet_name, scope_size, subnet_scope_size, root_site_id, hidden_site,
real_hidden_site, real_site_name, site_name, tree_level, tree_path, real_tree_path,
vlsm_subnet_id, vlsm_block_id, block_level, block_vlsm_subnet_id, row_enabled, sub-
net_is_valid, subnet_path, allocated_percent, subnet_used_percent, scope_size_allocated,
block_size_used, scope_size_used, ip_used_percent, block_name, block_id, site_id, wait-
ing_status, waiting_state, subnet_class_name, subnet_class_parameters, block_block_id,
block_scope_size, real_site_id, top_tree_level, real_tree_level, site_is_template, site_descrip-
tion, site_class_name, site_class_parameters, site_custom1, site_custom2, site_custom3,
block_custom1, block_custom2, block_custom3, subnet_custom1, subnet_custom2, sub-
net_custom3, block_class_name, block_start_ip_addr, block_end_ip_addr, container_name,
container_id, subnet_level.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block_subnet_id, type, subnet_id, start_ip_addr,

end_ip_addr, subnet_name, scope_size, subnet_scope_size, root_site_id, hidden_site,
real_hidden_site, real_site_name, site_name, tree_level, tree_path, real_tree_path,
vlsm_subnet_id, vlsm_block_id, block_level, block_vlsm_subnet_id, row_enabled, sub-
net_is_valid, subnet_path, allocated_percent, subnet_used_percent, scope_size_allocated,
block_size_used, scope_size_used, ip_used_percent, block_name, block_id, site_id, wait-
ing_status, waiting_state, subnet_class_name, subnet_class_parameters, block_block_id,
block_scope_size, real_site_id, top_tree_level, real_tree_level, site_is_template, site_descrip-
tion, site_class_name, site_class_parameters, site_custom1, site_custom2, site_custom3,
block_custom1, block_custom2, block_custom3, subnet_custom1, subnet_custom2, sub-
net_custom3, block_class_name, block_start_ip_addr, block_end_ip_addr, container_name,
container_id, subnet_level.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

51
 IPv4 Block

total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

52
 IPv4 Block

Name
ip_block_subnet_list — List the IPv4 blocks and subnets
Description
The service ip_block_subnet_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block_subnet_id, type, subnet_id, start_ip_addr,

end_ip_addr, subnet_name, scope_size, subnet_scope_size, root_site_id, hidden_site,
real_hidden_site, real_site_name, site_name, tree_level, tree_path, real_tree_path,
vlsm_subnet_id, vlsm_block_id, block_level, block_vlsm_subnet_id, row_enabled, sub-
net_is_valid, subnet_path, allocated_percent, subnet_used_percent, scope_size_allocated,
block_size_used, scope_size_used, ip_used_percent, block_name, block_id, site_id, wait-
ing_status, waiting_state, subnet_class_name, subnet_class_parameters, block_block_id,
block_scope_size, real_site_id, top_tree_level, real_tree_level, site_is_template, site_descrip-
tion, site_class_name, site_class_parameters, site_custom1, site_custom2, site_custom3,
block_custom1, block_custom2, block_custom3, subnet_custom1, subnet_custom2, sub-
net_custom3, block_class_name, block_start_ip_addr, block_end_ip_addr, container_name,
container_id, subnet_level.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

53
 IPv4 Block

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
block_subnet_id
Not documented.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
start_ip_addr
First IP address of the range.
end_ip_addr
Last IP address of the range.
subnet_name
Subnet name.
scope_size
Size of the container either it is a block or a subnet.
subnet_scope_size
Size of the subnet (number of IP addresses).
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block_level
Block6 level.
block_vlsm_subnet_id
Not documented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
subnet_is_valid
Tell if the subnet is valid or not. It is used after an import form the Internet registrar.
subnet_path
Subnet path.
allocated_percent
Percentage of allocated subnets just below the container.
subnet_used_percent
Percentage of used terminal subnet within the container it belongs.
scope_size_allocated
Number of allocated subnets just below the container.

54
 IPv4 Block

block_size_used
Number of used terminal subnets within the container it belongs.
scope_size_used
Number of IP addresses used in a subnet.
ip_used_percent
Percentage of IP addresses used in a subnet.
block_name
The IPv4 block name.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
waiting_status
Status of the pending operation.
waiting_state
State of the pending creation used when update third external database as Internet registrar.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet_class_parameters
The subnet_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
block_block_id
Not documented.
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
top_tree_level
Not documented.
site_is_template
Space is a template.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.

55
 IPv4 Block

site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
container_name
Not documented.
container_id
Not documented.
subnet_level
Not documented.

56
 IPv4 Block

Name
ip_block_class_list — List of the classes configured and applied on IPv4 blocks
Description
The service ip_block_class_list allows to list the classes configured and applied on IPv4 blocks.
The rows returned to the user running the service depend on the resources granted to the group
they belong to. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it.

Input Parameters
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

57
 IPv4 Block

Name
ip_block_admin_group_count — Total number of groups that can access the IPv4
block list

Description
The service ip_block_admin_group_count allows to display the total number of groups of users
that can access the IPv4 block list. The rows returned to the user running the service are not
subject to the group resources, this service returns data as if the user running it belonged to the
admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

58
 IPv4 Block

Name
ip_block_admin_group_list — List all the groups that can access the IPv4 block
list

Description
The service ip_block_admin_group_list allows to list all the groups of users that can access the
IPv4 block list. The rows returned to the user running the service are not subject to the group
resources, this service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

59
 IPv4 Block

grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

60
 IPv4 Block

Name
ip_block_admin_service_count — Total number of rights for a group to add/delete
objects in IPv4 blocks

Description
The service ip_block_admin_service_count allows to display the total number of rights for a group
of users to add/delete objects in an IPv4 block. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

61
 IPv4 Block

Name
ip_block_admin_service_list — List all the rights of a group to add/delete objects
in IPv4 blocks

Description
The service ip_block_admin_service_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

62
 IPv4 Block

Name
group_block_add — Add an IPv4 block as group resource
Description
The service group_block_add allows to add an object as resource for a group of users. You must
specify the group of users and the object that you set as resource. Once set as a resource, the
group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_name
The IPv4 block name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

63
 IPv4 Block

Name
group_block_delete — Remove an IPv4 block from a group resources
Description
The service group_block_delete allows to delete SOLIDserver database object. The service
group_block_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_name
The IPv4 block name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

64
 IPv4 Block

Name
ip_block_delete — Delete an IPv4 block
Description
The service ip_block_delete allows to delete SOLIDserver database object. The service
ip_block_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_addr
Block start IP address.
block_end_addr
Block end IP address.
block_size
Block size.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

65
Chapter 12. IPv6 Block

66
 IPv6 Block

Name
ip6_block6_add — Add/Edit an IPv6 block
Description
The service ip6_block6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_name
The IPv6 block name.
block6_addr
Block6 start IP6 address.
block6_end_addr
Block6 end IP6 address.
block6_prefix
Block6 prefix.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
block6_class_parameters
The block6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by block6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
block_level
Block6 level.

67
 IPv6 Block

keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

68
 IPv6 Block

Name
ip6_block6_count — Number of IPv6 blocks
Description
The service ip6_block6_count allows to display the number of IPv6 blocks.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block6_prefix, block_path, type, top_tree_level,

block_level, block6_id, vlsm_subnet6_id, block6_custom1, block6_custom2, block6_custom3,
block6_class_name, block6_sort_name, real_site_id, site_name, real_tree_level,
real_tree_path, block6_name, scope_size, block6_size, block6_type, block6_description,
start_ip6_addr, end_ip6_addr, block6_start_ip_addr, block6_end_ip_addr, vlsm_site_id,
vlsm_site_name, parent_site_id, block6_class_parameters, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3,
block6_start_ip_addr, block6_end_ip_addr, tree_path, tree_level, site_id, hidden_site,
real_hidden_site, real_site_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

69
 IPv6 Block

Name
ip6_block6_list — List the IPv6 blocks
Description
The service ip6_block6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block6_prefix, block_path, type, top_tree_level,

block_level, block6_id, vlsm_subnet6_id, block6_custom1, block6_custom2, block6_custom3,
block6_class_name, block6_sort_name, real_site_id, site_name, real_tree_level,
real_tree_path, block6_name, scope_size, block6_size, block6_type, block6_description,
start_ip6_addr, end_ip6_addr, block6_start_ip_addr, block6_end_ip_addr, vlsm_site_id,
vlsm_site_name, parent_site_id, block6_class_parameters, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3,
block6_start_ip_addr, block6_end_ip_addr, tree_path, tree_level, site_id, hidden_site,
real_hidden_site, real_site_name.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
block6_prefix
Block6 prefix.

70
 IPv6 Block

block_path
Block path.
top_tree_level
Not documented.
block_level
Block6 level.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
site_name
site name.
block6_name
The IPv6 block name.
scope_size
Size of the container either it is a block or a subnet.
block6_size
Not documented.
block6_type
Block type.
block6_description
Not documented.
start_ip6_addr
First IP address of the range.
end_ip6_addr
Last IP address of the range.
block6_start_ip_addr
Not documented.
block6_end_ip_addr
Not documented.
vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID) used to join foreign data. This
identifier is a unique numeric key value that is automatically incremented.
vlsm_site_name
VLSM space name.
parent_site_id
The parent_site_id parameter is the Space parent identifier (ID) used to join foreign data.
This identifier is a unique numeric key value that is automatically incremented.
block6_class_parameters
The block6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block6_class_parameters parameter accepts several meta-

71
 IPv6 Block

data values set in the following URL style format: metadata1=value1&metadata2=value2&.

To be accepted by block6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
block6_start_ip_addr
Not documented.
block6_end_ip_addr
Not documented.
tree_level
Depth of imbricated spaces.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

72
 IPv6 Block

Name
ip6_block6_info — Display the properties of an IPv6 block
Description
The service ip6_block6_info returns the information on the object specified in input.

Input Parameters
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
block6_prefix
Block6 prefix.
block_path
Block path.
top_tree_level
Not documented.
block_level
Block6 level.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
site_name
site name.
block6_name
The IPv6 block name.
scope_size
Size of the container either it is a block or a subnet.
block6_size
Not documented.
block6_type
Block type.
block6_description
Not documented.

73
 IPv6 Block

start_ip6_addr
First IP address of the range.
end_ip6_addr
Last IP address of the range.
block6_start_ip_addr
Not documented.
block6_end_ip_addr
Not documented.
vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID) used to join foreign data. This
identifier is a unique numeric key value that is automatically incremented.
vlsm_site_name
VLSM space name.
parent_site_id
The parent_site_id parameter is the Space parent identifier (ID) used to join foreign data.
This identifier is a unique numeric key value that is automatically incremented.
block6_class_parameters
The block6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by block6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
block6_start_ip_addr
Not documented.
block6_end_ip_addr
Not documented.
tree_level
Depth of imbricated spaces.

74
 IPv6 Block

site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

75
 IPv6 Block

Name
ip6_block6_subnet6_count — Number of IPv6 blocks and subnets
Description
The service ip6_block6_subnet6_count allows to display the number of IPv6 blocks and subnets.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block6_subnet6_id, type, subnet6_id, start_ip6_addr,

end_ip6_addr, subnet6_name, scope_size, subnet6_scope_size, root_site_id, hidden_site,
real_hidden_site, real_site_name, site_name, tree_level, tree_path, real_tree_path,
vlsm_subnet6_id, vlsm_block6_id, block_level, block6_vlsm_subnet6_id, row_enabled,
subnet6_is_valid, subnet_path, block6_name, block6_id, site_id, waiting_status, waiting_state,
subnet6_class_name, subnet6_class_parameters, block6_block6_id, block6_scope_size,
real_site_id, top_tree_level, real_tree_level, site_description, site_class_name,
site_class_parameters, site_custom1, site_custom2, site_custom3, block6_class_name,
block6_start_ip6_addr, block6_end_ip6_addr, container_name, container_id, subnet_level,
subnet6_prefix, block6_prefix.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block6_subnet6_id, type, subnet6_id, start_ip6_addr,

end_ip6_addr, subnet6_name, scope_size, subnet6_scope_size, root_site_id, hidden_site,
real_hidden_site, real_site_name, site_name, tree_level, tree_path, real_tree_path,
vlsm_subnet6_id, vlsm_block6_id, block_level, block6_vlsm_subnet6_id, row_enabled,
subnet6_is_valid, subnet_path, block6_name, block6_id, site_id, waiting_status, waiting_state,
subnet6_class_name, subnet6_class_parameters, block6_block6_id, block6_scope_size,
real_site_id, top_tree_level, real_tree_level, site_description, site_class_name,
site_class_parameters, site_custom1, site_custom2, site_custom3, block6_class_name,
block6_start_ip6_addr, block6_end_ip6_addr, container_name, container_id, subnet_level,
subnet6_prefix, block6_prefix.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

76
 IPv6 Block

Name
ip6_block6_subnet6_list — List the IPv6 blocks and subnets
Description
The service ip6_block6_subnet6_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: block6_subnet6_id, type, subnet6_id, start_ip6_addr,

end_ip6_addr, subnet6_name, scope_size, subnet6_scope_size, root_site_id, hidden_site,
real_hidden_site, real_site_name, site_name, tree_level, tree_path, real_tree_path,
vlsm_subnet6_id, vlsm_block6_id, block_level, block6_vlsm_subnet6_id, row_enabled,
subnet6_is_valid, subnet_path, block6_name, block6_id, site_id, waiting_status, waiting_state,
subnet6_class_name, subnet6_class_parameters, block6_block6_id, block6_scope_size,
real_site_id, top_tree_level, real_tree_level, site_description, site_class_name,
site_class_parameters, site_custom1, site_custom2, site_custom3, block6_class_name,
block6_start_ip6_addr, block6_end_ip6_addr, container_name, container_id, subnet_level,
subnet6_prefix, block6_prefix.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

77
 IPv6 Block

block6_subnet6_id
Not documented.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
start_ip6_addr
First IP address of the range.
end_ip6_addr
Last IP address of the range.
subnet6_name
Subnet6 name.
scope_size
Size of the container either it is a block or a subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block_level
Block6 level.
block6_vlsm_subnet6_id
Not documented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
subnet6_is_valid
Tell if the IPv6 subnet is valid or not. It is used after an import form the Internet registrar.
subnet_path
Subnet path.
block6_name
The IPv6 block name.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
waiting_status
Status of the pending operation.
waiting_state
State of the pending creation used when update third external database as Internet registrar.

78
 IPv6 Block

subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet6_class_parameters
The subnet6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet6_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
block6_block6_id
Not documented.
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
top_tree_level
Not documented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
container_name
Not documented.
container_id
Not documented.
subnet_level
Not documented.

79
 IPv6 Block

subnet6_prefix
Subnet6 prefix.
block6_prefix
Block6 prefix.

80
 IPv6 Block

Name
ip6_block6_class_list — List of the classes configured and applied on IPv6 blocks
Description
The service ip6_block6_class_list allows to list the classes configured and applied on IPv6 blocks.
The rows returned to the user running the service depend on the resources granted to the group
they belong to. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it.

Input Parameters
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

81
 IPv6 Block

Name
ip6_block6_admin_group_list — List all the groups that can access the IPv6 block
list

Description
The service ip6_block6_admin_group_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

82
 IPv6 Block

Name
ip6_block6_admin_service_list — List all the rights of a group to add/delete objects
in IPv6 blocks

Description
The service ip6_block6_admin_service_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

83
 IPv6 Block

Name
group_block6_add — Add an IPv6 block as group resource
Description
The service group_block6_add allows to add an object as resource for a group of users. You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_name
The IPv6 block name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

84
 IPv6 Block

Name
group_block6_delete — Remove an IPv6 block from a group resources
Description
The service group_block6_delete allows to delete SOLIDserver database object. The service
group_block6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_name
The IPv6 block name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

85
 IPv6 Block

Name
ip6_block6_delete — Delete an IPv6 block
Description
The service ip6_block6_delete allows to delete SOLIDserver database object. The service
ip6_block6_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_addr
Block6 start IP address.
block6_end_addr
Block6 end IP address.
block6_prefix
Block6 prefix.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

86
Chapter 13. IPv4 Subnet

87
 IPv4 Subnet

Name
ip_subnet_add — Add/Edit an IPv4 subnet
Description
The service ip_subnet_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Mandatory Parameters
Add process: (subnet_name && subnet_addr && (subnet_prefix || subnet_size || subnet_end_ad-
dr) && (subnet_id || subnet_name))

Edit process: (site_id || site_name)

Input Parameters List

site_id
The site_id parameter is the Space identifier (ID) used to join foreign data. It references the
space of the first subnet just below the block. This parameter must not be used in case of
imbricated subnet. This identifier is a unique numeric key value that is automatically incre-
mented.
site_name
Name of the space where the subnet is directly connected. It refers the space of the first
subnet just below the block. This parameter must not be used in case of imbricated subnet.
root_site_id
The root_site_id parameter is the Space identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
root_site_name
Name of the space that is used as the root of imbricated subnets. Unlike site_name the
root_site_name refers to the space which is the root of the tree of subnets.
vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID) used to join foreign data. This
identifier is a unique numeric key value that is automatically incremented. Unlike site_name
the root_site_name refers to the space which is the root of the tree of subnets.
vlsm_site_name
VLSM space name.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_name
Subnet name. It must be an alphanumeric string with a max length of 128 characters.

88
 IPv4 Subnet

subnet_addr
The start IPv4 address from the subnet. It must be an IPv4 in decimal format (i.e : 10.0.0.0).
This value is set at the creation and cannot be edited once the subnet exist.
subnet_end_addr
The start IPv4 address from the subnet. It must be an IPv4 in decimal format (i.e : 10.0.0.0).
This value is set at the creation and cannot be edited once the subnet exist.
subnet_size
The subnet size. Must be an integer greater than 0. This value is set at the creation and
cannot be edited once the subnet exist.
subnet_mask
Subnet mask.
subnet_prefix
Subnet prefix. It must be an integer between 0 and 32 included.This value is set at the creation
and cannot be edited once the block exist.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet_class_parameters
The subnet_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
permit_invalid
Must be 0 or 1. When set on 1, allow the subnet overlapping.
permit_overlap
Permit overlap (obsolete).
permit_no_block
Must be 0 or 1. When set on 1, allow to create subnet without a block. The subnet created
will be an orphan subnet.
changed_waiting_state
Must be 0 or 1. When set on 1, change waiting state (internal).
is_terminal
Must be 0 or 1. When set on 1, subnet will be terminal.
enabled
Must be 0 or 1. When set on 1, the status of the subnet will be Managed. When set on 0, the
status of the subnet will be Unmanaged.
keep_class_parameters
Must be 0 or 1. When set on 1, the value of the parameter subnet_class_parameters will be
added to the existing class parameters.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.

89
 IPv4 Subnet

additional_parameters
The additional_parameters is a data container used to pass your customized parameters to
rules started after a call to the service. The additional_parameters accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by additional_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
no_rule_exec
Must be 0 or 1. When set on 1, do not execute rules started after the execution of this service.

Output Parameters List

errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

90
 IPv4 Subnet

Name
ip_subnet_count — Number of IPv4 subnets
Description
The service ip_subnet_count allows to display the number of IPv4 subnets.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: subnet_id, type, subnet_path, subnet_is_default, sub-
net_sort_name, start_ip_addr, end_ip_addr, block_id, block_name, block_level,
block_start_ip_addr, block_end_ip_addr, block_type, site_id, vlsm_block_id, vlsm_site_id,
subnet_start_ip_addr, subnet_end_ip_addr, subnet_name, subnet_addr, scope_size, sub-
net_scope_size, block_scope_size, vlsm_subnet_id, subnet_type, subnet_class_name,
subnet_class_parameters, subnet_custom1, subnet_custom2, subnet_custom3,
site_is_template, site_name, real_tree_level, real_tree_path, real_hidden_site,
vlsm_site_name, subnet_row_enabled, subnet_is_valid, waiting_state, waiting_status,
block_class_name, block_path, vlsm_block_name, allocated_percent, subnet_used_percent,
scope_size_allocated, block_size_used, scope_size_used, ip_used_percent, root_site_id,
hidden_site, real_site_id, real_site_name, site_class_name, site_class_parameters,
row_enabled, site_custom1, site_custom2, site_custom3, site_description, tree_level,
tree_path, parent_site_name, block_custom1, block_custom2, block_custom3.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

91
 IPv4 Subnet

Name
ip_subnet_list — List the IPv4 subnets
Description
The service ip_subnet_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: subnet_id, type, subnet_path, subnet_is_default, sub-
net_sort_name, start_ip_addr, end_ip_addr, block_id, block_name, block_level,
block_start_ip_addr, block_end_ip_addr, block_type, site_id, vlsm_block_id, vlsm_site_id,
subnet_start_ip_addr, subnet_end_ip_addr, subnet_name, subnet_addr, scope_size, sub-
net_scope_size, block_scope_size, vlsm_subnet_id, subnet_type, subnet_class_name,
subnet_class_parameters, subnet_custom1, subnet_custom2, subnet_custom3,
site_is_template, site_name, real_tree_level, real_tree_path, real_hidden_site,
vlsm_site_name, subnet_row_enabled, subnet_is_valid, waiting_state, waiting_status,
block_class_name, block_path, vlsm_block_name, allocated_percent, subnet_used_percent,
scope_size_allocated, block_size_used, scope_size_used, ip_used_percent, root_site_id,
hidden_site, real_site_id, real_site_name, site_class_name, site_class_parameters,
row_enabled, site_custom1, site_custom2, site_custom3, site_description, tree_level,
tree_path, parent_site_name, block_custom1, block_custom2, block_custom3.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

92
 IPv4 Subnet

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_path
Subnet path.
subnet_is_default
Recycle bin subnet.
start_ip_addr
First IP address of the range.
end_ip_addr
Last IP address of the range.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_name
The IPv4 block name.
block_level
Block6 level.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
block_type
Block type.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
subnet_start_ip_addr
First IP address of the subnet.
subnet_end_ip_addr
Last IP address of the subnet.
subnet_name
Subnet name.
subnet_addr
Subnet start IP address.
scope_size
Size of the container either it is a block or a subnet.

93
 IPv4 Subnet

subnet_scope_size
Size of the subnet (number of IP addresses).
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet_class_parameters
The subnet_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
site_is_template
Space is a template.
site_name
site name.
vlsm_site_name
VLSM space name.
subnet_is_valid
Tell if the subnet is valid or not. It is used after an import form the Internet registrar.
waiting_state
State of the pending creation used when update third external database as Internet registrar.
waiting_status
Status of the pending operation.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
block_path
Block path.
vlsm_block_name
Name of the block that contain the subnet.
allocated_percent
Percentage of allocated subnets just below the container.
subnet_used_percent
Percentage of used terminal subnet within the container it belongs.
scope_size_allocated
Number of allocated subnets just below the container.
block_size_used
Number of used terminal subnets within the container it belongs.

94
 IPv4 Subnet

scope_size_used
Number of IP addresses used in a subnet.
ip_used_percent
Percentage of IP addresses used in a subnet.
root_site_id
Root space ID in the IP address hierarchy.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
site_description
Space description.
tree_level
Depth of imbricated spaces.
parent_site_name
Space parent name.

95
 IPv4 Subnet

Name
ip_subnet_info — Display the properties of an IPv4 subnet
Description
The service ip_subnet_info returns the information on the object specified in input.

Input Parameters
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_path
Subnet path.
subnet_is_default
Recycle bin subnet.
start_ip_addr
First IP address of the range.
end_ip_addr
Last IP address of the range.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_name
The IPv4 block name.
block_level
Block6 level.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
block_type
Block type.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

96
 IPv4 Subnet

vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
subnet_start_ip_addr
First IP address of the subnet.
subnet_end_ip_addr
Last IP address of the subnet.
subnet_name
Subnet name.
subnet_addr
Subnet start IP address.
scope_size
Size of the container either it is a block or a subnet.
subnet_scope_size
Size of the subnet (number of IP addresses).
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet_class_parameters
The subnet_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
site_is_template
Space is a template.
site_name
site name.
vlsm_site_name
VLSM space name.
subnet_is_valid
Tell if the subnet is valid or not. It is used after an import form the Internet registrar.
waiting_state
State of the pending creation used when update third external database as Internet registrar.
waiting_status
Status of the pending operation.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.

97
 IPv4 Subnet

block_path
Block path.
vlsm_block_name
Name of the block that contain the subnet.
allocated_percent
Percentage of allocated subnets just below the container.
subnet_used_percent
Percentage of used terminal subnet within the container it belongs.
scope_size_allocated
Number of allocated subnets just below the container.
block_size_used
Number of used terminal subnets within the container it belongs.
scope_size_used
Number of IP addresses used in a subnet.
ip_used_percent
Percentage of IP addresses used in a subnet.
root_site_id
Root space ID in the IP address hierarchy.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
site_description
Space description.
tree_level
Depth of imbricated spaces.
parent_site_name
Space parent name.

98
 IPv4 Subnet

Name
ip_subnet_address_count — Number of used IPv4 addresses in a subnet/pool
Description
The service ip_subnet_address_count allows to display the number of used IPv4 addresses in
the subnet or pool specified in input.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
subnet_id
The subnet identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_id
The pool identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

99
 IPv4 Subnet

Name
ip_subnet_address_list — List the used IPv4 addresses in a subnet/pool
Description
The service ip_subnet_address_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
subnet_id
The subnet identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_id
The pool identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

100
 IPv4 Subnet

Name
ip_free_subnet_count — Number of free IPv4 subnets
Description
The service ip_free_subnet_count allows to display the number of free IPv4 subnets.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

101
 IPv4 Subnet

Name
ip_free_subnet_list — List the free IPv4 subnets
Description
The service ip_free_subnet_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it.. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

102
 IPv4 Subnet

Name
ip_find_free_subnet — Find free IPv4 subnets
Description
The service ip_find_free_subnet allows to find free IPv4 subnets in the database.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
block_path
Block path.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
start_ip_addr
Start IP address.
block_id
IPv4 block identifier (ID).
block_name
IPv4 block name.
site_id
Space identifier (ID).
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

103
 IPv4 Subnet

Name
ip_subnet_class_list — List of the classes configured and applied on IPv4 subnets
Description
The service ip_subnet_class_list allows to list the classes configured and applied on IPv4 subnets.
The rows returned to the user running the service depend on the resources granted to the group
they belong to. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it.

Input Parameters
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

104
 IPv4 Subnet

Name
ip_subnet_admin_group_count — Total number of groups that can access the
IPv4 subnet list

Description
The service ip_subnet_admin_group_count allows to display the total number of groups of users
that can access the IPv4 subnet list. The rows returned to the user running the service are not
subject to the group resources, this service returns data as if the user running it belonged to the
admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

105
 IPv4 Subnet

Name
ip_subnet_admin_group_list — List all the groups that can access the IPv4 subnet
list

Description
The service ip_subnet_admin_group_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

106
 IPv4 Subnet

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

107
 IPv4 Subnet

Name
ip_subnet_admin_service_count — Total number of rights for a group to
add/delete objects in IPv4 subnets

Description
The service ip_subnet_admin_service_count allows to display the total number of rights for a
group of users to add/delete objects in a DHCPv4 subnet. The rows returned to the user running
the service are not subject to the group resources, this service returns data as if the user running
it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

108
 IPv4 Subnet

Name
ip_subnet_admin_service_list — List all the rights of a group to add/delete objects
in IPv4 subnets

Description
The service ip_subnet_admin_service_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

109
 IPv4 Subnet

Name
group_subnet_add — Add an IPv4 subnet as group resource
Description
The service group_subnet_add allows to add an object as resource for a group of users. You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

110
 IPv4 Subnet

Name
group_subnet_delete — Remove an IPv4 subnet from a group resources
Description
The service group_subnet_delete allows to delete SOLIDserver database object. The service
group_subnet_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

111
 IPv4 Subnet

Name
ip_subnet_delete — Delete an IPv4 subnet
Description
The service ip_subnet_delete allows to delete SOLIDserver database object. The service
ip_subnet_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_name
Subnet name.
subnet_addr
Subnet start IP address.
subnet_end_addr
Subnet end IP address.
subnet_size
Subnet size.
subnet_mask
Subnet mask.
subnet_prefix
Subnet prefix.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet_class_parameters
The subnet_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
additional_parameters
Additional parameters passed to rules.

112
 IPv4 Subnet

no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

113
Chapter 14. IPv6 Subnet

114
 IPv6 Subnet

Name
ip6_subnet6_add — Add/Edit an IPv6 subnet
Description
The service ip6_subnet6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
root_site_id
The root_site_id parameter is the Space identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
root_site_name
Space name.
vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
vlsm_site_name
VLSM space name.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet6_name
Subnet6 name.
subnet6_addr
Subnet6 start IP address.
subnet6_end_addr
Subnet6 end IP address.
subnet6_prefix
Subnet6 prefix.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.

115
 IPv6 Subnet

subnet6_class_parameters
The subnet6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet6_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
permit_invalid
Permit invalid (not a real subnet6/allow overlap).
permit_overlap
Permit overlap (obsolete).
permit_no_block6
Allow to create subnet6 without block6.
changed_waiting_state
Changed waiting state (internal).
is_terminal
Subnet6 is terminal.
enabled
Manage/Unmanage.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

116
 IPv6 Subnet

Name
ip6_subnet6_count — Number of IPv6 subnets
Description
The service ip6_subnet6_count allows to display the number of IPv6 subnets.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: subnet6_id, type, subnet_path, subnet6_is_default,

subnet6_sort_name, start_ip6_addr, end_ip6_addr, block6_id, block6_name, block_level,
block6_start_ip6_addr, block6_end_ip6_addr, block6_type, block6_prefix, site_id,
vlsm_block6_id, vlsm_site_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr, subnet6_name,
subnet6_addr, scope_size, subnet6_scope_size, block6_scope_size, vlsm_subnet6_id,
subnet6_class_name, subnet6_class_parameters, subnet6_custom1, subnet6_custom2,
subnet6_custom3, site_name, real_tree_level, real_tree_path, real_hidden_site,
vlsm_site_name, subnet6_row_enabled, subnet6_is_valid, waiting_state, waiting_status,
block6_class_name, block_path, vlsm_block6_name, root_site_id, hidden_site, real_site_id,
real_site_name, site_class_name, site_class_parameters, row_enabled, site_custom1,
site_custom2, site_custom3, site_description, tree_level, tree_path, parent_site_name,
block6_custom1, block6_custom2, block6_custom3.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

117
 IPv6 Subnet

Name
ip6_subnet6_list — List the IPv6 subnets
Description
The service ip6_subnet6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: subnet6_id, type, subnet_path, subnet6_is_default,

subnet6_sort_name, start_ip6_addr, end_ip6_addr, block6_id, block6_name, block_level,
block6_start_ip6_addr, block6_end_ip6_addr, block6_type, block6_prefix, site_id,
vlsm_block6_id, vlsm_site_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr, subnet6_name,
subnet6_addr, scope_size, subnet6_scope_size, block6_scope_size, vlsm_subnet6_id,
subnet6_class_name, subnet6_class_parameters, subnet6_custom1, subnet6_custom2,
subnet6_custom3, site_name, real_tree_level, real_tree_path, real_hidden_site,
vlsm_site_name, subnet6_row_enabled, subnet6_is_valid, waiting_state, waiting_status,
block6_class_name, block_path, vlsm_block6_name, root_site_id, hidden_site, real_site_id,
real_site_name, site_class_name, site_class_parameters, row_enabled, site_custom1,
site_custom2, site_custom3, site_description, tree_level, tree_path, parent_site_name,
block6_custom1, block6_custom2, block6_custom3.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

118
 IPv6 Subnet

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_path
Subnet path.
subnet6_is_default
Recycle bin subnet.
start_ip6_addr
First IP address of the range.
end_ip6_addr
Last IP address of the range.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_name
The IPv6 block name.
block_level
Block6 level.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
block6_type
Block type.
block6_prefix
Block6 prefix.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
subnet6_end_ip6_addr
Last IP v6 address of the subnet.
subnet6_name
Subnet6 name.
subnet6_addr
Subnet6 start IP address.

119
 IPv6 Subnet

scope_size
Size of the container either it is a block or a subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet6_class_parameters
The subnet6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet6_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
site_name
site name.
vlsm_site_name
VLSM space name.
subnet6_is_valid
Tell if the IPv6 subnet is valid or not. It is used after an import form the Internet registrar.
waiting_state
State of the pending creation used when update third external database as Internet registrar.
waiting_status
Status of the pending operation.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
block_path
Block path.
root_site_id
Root space ID in the IP address hierarchy.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be

120
 IPv6 Subnet

accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
site_description
Space description.
tree_level
Depth of imbricated spaces.
parent_site_name
Space parent name.

121
 IPv6 Subnet

Name
ip6_subnet6_info — Display the properties of an IPv6 subnet
Description
The service ip6_subnet6_info returns the information on the object specified in input.

Input Parameters
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_path
Subnet path.
subnet6_is_default
Recycle bin subnet.
start_ip6_addr
First IP address of the range.
end_ip6_addr
Last IP address of the range.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block6_name
The IPv6 block name.
block_level
Block6 level.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
block6_type
Block type.
block6_prefix
Block6 prefix.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

122
 IPv6 Subnet

vlsm_site_id
The vlsm_site_id parameter is the VLSM space identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
subnet6_end_ip6_addr
Last IP v6 address of the subnet.
subnet6_name
Subnet6 name.
subnet6_addr
Subnet6 start IP address.
scope_size
Size of the container either it is a block or a subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet6_class_parameters
The subnet6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet6_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
site_name
site name.
vlsm_site_name
VLSM space name.
subnet6_is_valid
Tell if the IPv6 subnet is valid or not. It is used after an import form the Internet registrar.
waiting_state
State of the pending creation used when update third external database as Internet registrar.
waiting_status
Status of the pending operation.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
block_path
Block path.

123
 IPv6 Subnet

root_site_id
Root space ID in the IP address hierarchy.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
site_description
Space description.
tree_level
Depth of imbricated spaces.
parent_site_name
Space parent name.

124
 IPv6 Subnet

Name
ip6_subnet6_address_count — Number of used IPv6 addresses in a subnet/pool
Description
The service ip6_subnet6_address_count allows to display the number of used IPv6 addresses
in the subnet or pool specified in input.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

125
 IPv6 Subnet

Name
ip6_subnet6_address_list — List the used IPv6 addresses in a subnet/pool
Description
The service ip6_subnet6_address_list allows to list entries from SOLIDserver database.To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

126
 IPv6 Subnet

Name
ip6_used_subnet6_address_count — Number of used IPv6 addresses
Description
The service ip6_subnet6_address_count allows to display the number of used IPv6 addresses.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip6_id, root_site_id, hidden_site, real_site_name,

real_site_id, site_name, tree_level, tree_path, real_tree_path, block6_name, ip6_addr,
ip6_name, ip6_custom1, ip6_custom2, ip6_custom3, ip6_mac_addr, ip6_class_name, sub-
net6_name, pool6_name, site_id, subnet6_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr,
subnet6_scope_size, block6_scope_size, block6_id, vlsm_subnet6_id, ip6_class_parameters,
pool6_class_name, pool6_id, pool6_read_only, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3, par-
ent_site_name, block6_class_name, scope_size, block6_custom1, block6_custom2,
block6_custom3, block6_prefix, block6_start_ip6_addr, block6_end_ip6_addr, vlsm_block6_id,
subnet6_class_name, subnet6_custom1, subnet6_custom2, subnet6_custom3, pool6_size,
pool6_start_ip6_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

127
 IPv6 Subnet

Name
ip6_used_subnet6_address_list — List the used IPv6 addresses
Description
The service ip6_used_subnet6_address_list allows to list entries from SOLIDserver database.
To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip6_id, root_site_id, hidden_site, real_site_name,

real_site_id, site_name, tree_level, tree_path, real_tree_path, block6_name, ip6_addr,
ip6_name, ip6_custom1, ip6_custom2, ip6_custom3, ip6_mac_addr, ip6_class_name, sub-
net6_name, pool6_name, site_id, subnet6_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr,
subnet6_scope_size, block6_scope_size, block6_id, vlsm_subnet6_id, ip6_class_parameters,
pool6_class_name, pool6_id, pool6_read_only, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3, par-
ent_site_name, block6_class_name, scope_size, block6_custom1, block6_custom2,
block6_custom3, block6_prefix, block6_start_ip6_addr, block6_end_ip6_addr, vlsm_block6_id,
subnet6_class_name, subnet6_custom1, subnet6_custom2, subnet6_custom3, pool6_size,
pool6_start_ip6_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

128
 IPv6 Subnet

ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block6_name
The IPv6 block name.
ip6_addr
IP6 address.
ip6_name
IP6 address name.
ip6_mac_addr
IP6 address MAC address.
ip6_class_name
The ip6_class_name is the name of the file class that will used for this object. The name of
ip6_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip6_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
subnet6_name
Subnet6 name.
pool6_name
Pool6 name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
subnet6_end_ip6_addr
Last IP v6 address of the subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip6_class_parameters
The ip6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global

129
 IPv6 Subnet

customized fields as well. The ip6_class_parameters parameter accepts several meta-data

values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by ip6_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool6_read_only
Pool6 is in read only mode.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
scope_size
Size of the container either it is a block or a subnet.
block6_prefix
Block6 prefix.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.

130
 IPv6 Subnet

subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
pool6_size
Not documented.
pool6_start_ip6_addr
Not documented.

131
 IPv6 Subnet

Name
ip6_used_subnet6_address_info — Display the properties of a used IPv6 address
Description
The service ip6_used_subnet6_address_info return the information on the object specified in
input.

Input Parameters
ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block6_name
The IPv6 block name.
ip6_addr
IP6 address.
ip6_name
IP6 address name.
ip6_mac_addr
IP6 address MAC address.
ip6_class_name
The ip6_class_name is the name of the file class that will used for this object. The name of
ip6_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip6_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
subnet6_name
Subnet6 name.
pool6_name
Pool6 name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

132
 IPv6 Subnet

subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
subnet6_end_ip6_addr
Last IP v6 address of the subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip6_class_parameters
The ip6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The ip6_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by ip6_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool6_read_only
Pool6 is in read only mode.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

133
 IPv6 Subnet

row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
scope_size
Size of the container either it is a block or a subnet.
block6_prefix
Block6 prefix.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
pool6_size
Not documented.
pool6_start_ip6_addr
Not documented.

134
 IPv6 Subnet

Name
ip6_find_free_subnet6 — Find free IPv6 subnets
Description
The service ip6_find_free_subnet6 allows to find free IPv6 subnets in the database.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
site_id
The space identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
block_path
Block path.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
start_ip6_addr
First IP address of the range.
block6_name
The IPv6 block name.
block6_type
Block type.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
site_id
The space identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

135
 IPv6 Subnet

Name
ip6_free_subnet6_count — Number of free IPv6 subnets
Description
The service ip6_free_subnet6_count allows to display the number of free IPv6 subnets.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

136
 IPv6 Subnet

Name
ip6_free_subnet6_list — List the free IPv6 subnets
Description
The service ip6_free_subnet6_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

137
 IPv6 Subnet

Name
ip6_subnet6_class_list — List of the classes configured and applied on IPv6 subnets
Description
The service ip6_subnet6_class_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it.

Input Parameters
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

138
 IPv6 Subnet

Name
ip6_subnet6_admin_group_list — List all the groups that can access the IPv6
subnet list

Description
The service ip6_subnet6_admin_group_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

139
 IPv6 Subnet

Name
ip6_subnet6_admin_service_list — List all the rights of a group to add/delete
objects in IPv6 subnets

Description
The service ip6_subnet6_admin_service_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

140
 IPv6 Subnet

Name
group_subnet6_add — Add an IPv6 subnet as group resource
Description
The service group_subnet6_add allows to add an object as resource for a group of users. You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

141
 IPv6 Subnet

Name
group_subnet6_delete — Remove an IPv6 subnet from a group resources
Description
The service group_subnet6_delete allows to delete SOLIDserver database object. The service
group_subnet6_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

142
 IPv6 Subnet

Name
ip6_subnet6_delete — Delete an IPv6 subnet
Description
The service ip6_subnet6_delete allows to delete SOLIDserver database object. The service
ip6_subnet6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet6_name
Subnet6 name.
subnet6_addr
Subnet6 start IP address.
subnet6_end_addr
Subnet6 end IP address.
subnet6_prefix
Subnet6 prefix.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
subnet6_class_parameters
The subnet6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The subnet6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by subnet6_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

143
 IPv6 Subnet

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

144
Chapter 15. IPv4 Pool

145
 IPv4 Pool

Name
ip_pool_add — Add/Edit an IPv4 pool
Description
The service ip_pool_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
start_addr
Pool start IP address.
end_addr
Pool end IP address.
pool_size
Pool size.
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_class_parameters
The pool_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by pool_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
pool_read_only
Pool is in read only mode.

146
 IPv4 Pool

keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

147
 IPv4 Pool

Name
ip_pool_count — Number of IPv4 pools
Description
The service ip_pool_count allows to display the number of IPv4 pools.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: real_site_id, real_tree_path, real_hidden_site,

site_is_template, hidden_site, tree_path, pool_id, pool_name, pool_class_name,
pool_class_parameters, pool_read_only, start_ip_addr, end_ip_addr, scope_size,
pool_custom1, pool_custom2, pool_custom3, site_name, site_id, block_name, block_id,
vlsm_subnet_id, subnet_name, vlsm_block_id, subnet_addr, subnet_id, site_description,
site_class_name, site_class_parameters, row_enabled, site_custom1, site_custom2,
site_custom3, parent_site_name, block_custom1, block_custom2, block_custom3,
block_scope_size, block_start_ip_addr, block_end_ip_addr, subnet_start_ip_addr, subnet_cus-
tom1, subnet_custom2, subnet_custom3, pool_size, pool_start_ip_addr, pool_end_ip_addr,
block_class_name, block_path, block_level.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

148
 IPv4 Pool

Name
ip_pool_list — List the IPv4 pools
Description
The service ip_pool_list allows to list entries from SOLIDserver database.To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: real_site_id, real_tree_path, real_hidden_site,

site_is_template, hidden_site, tree_path, pool_id, pool_name, pool_class_name,
pool_class_parameters, pool_read_only, start_ip_addr, end_ip_addr, scope_size,
pool_custom1, pool_custom2, pool_custom3, site_name, site_id, block_name, block_id,
vlsm_subnet_id, subnet_name, vlsm_block_id, subnet_addr, subnet_id, site_description,
site_class_name, site_class_parameters, row_enabled, site_custom1, site_custom2,
site_custom3, parent_site_name, block_custom1, block_custom2, block_custom3,
block_scope_size, block_start_ip_addr, block_end_ip_addr, subnet_start_ip_addr, subnet_cus-
tom1, subnet_custom2, subnet_custom3, pool_size, pool_start_ip_addr, pool_end_ip_addr,
block_class_name, block_path, block_level.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

149
 IPv4 Pool

site_is_template
Space is a template.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_name
Pool name.
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_class_parameters
The pool_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by pool_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
pool_read_only
Pool is in read only mode.
start_ip_addr
First IP address of the range.
end_ip_addr
Last IP address of the range.
scope_size
Size of the container either it is a block or a subnet.
site_name
site name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
block_name
The IPv4 block name.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
subnet_name
Subnet name.
subnet_addr
Subnet start IP address.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
site_description
Space description.

150
 IPv4 Pool

site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
subnet_start_ip_addr
First IP address of the subnet.
pool_size
Pool size.
pool_start_ip_addr
Not documented.
pool_end_ip_addr
Not documented.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
block_path
Block path.
block_level
Block6 level.

151
 IPv4 Pool

Name
ip_pool_name_list — List the name of the IPv4 pools and their configured classes for
a specific subnet

Description
The service ip_pool_name_list allows to the name and class configured on the pool of a specific
IPv4 subnet. The rows returned to the user running the service depend on the resources granted
to the group they belong to. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted permission to use it.

Input Parameters
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
pool_name
The IPv4 pool name.
pool_class_name
The name of the class configured on the IPv4 pool.
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

152
 IPv4 Pool

Name
ip_pool_info — Display the properties of an IPv4 pool
Description
The service ip_pool_info returns the information on the object specified in input.

Input Parameters
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
site_is_template
Space is a template.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_name
Pool name.
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_class_parameters
The pool_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by pool_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
pool_read_only
Pool is in read only mode.
start_ip_addr
First IP address of the range.
end_ip_addr
Last IP address of the range.
scope_size
Size of the container either it is a block or a subnet.
site_name
site name.

153
 IPv4 Pool

site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
block_name
The IPv4 block name.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
subnet_name
Subnet name.
subnet_addr
Subnet start IP address.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
subnet_start_ip_addr
First IP address of the subnet.
pool_size
Pool size.
pool_start_ip_addr
Not documented.

154
 IPv4 Pool

pool_end_ip_addr
Not documented.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
block_path
Block path.
block_level
Block6 level.

155
 IPv4 Pool

Name
ip_pool_class_list — List of the classes configured and applied on IPv4 pools
Description
The service ip_pool_class_list allows to list all the classes configured and applied on IPv4 pools.
The rows returned to the user running the service depend on the resources granted to the group
they belong to. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted permission to use it.

Input Parameters
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

156
 IPv4 Pool

Name
ip_pool_admin_group_count — Total number of groups that can access the IPv4
pool list

Description
The service ip_pool_admin_group_count allows to display the total number of groups of users
that can access the IPv4 pool list. The rows returned to the user running the service are not
subject to the group resources, this service returns data as if the user running it belonged to the
admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

157
 IPv4 Pool

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

158
 IPv4 Pool

Name
ip_pool_admin_group_list — List all the groups that can access the IPv4 pool list
Description
The service ip_pool_admin_group_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

159
 IPv4 Pool

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

160
 IPv4 Pool

Name
ip_pool_admin_service_count — Total number of rights for a group to add/delete
objects in IPv4 pools

Description
The service ip_pool_admin_service_count allows to display the total number of rights for a group
of users to add/delete objects in an IPv4 pool. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

161
 IPv4 Pool

Name
ip_pool_admin_service_list — the rights of a group to add/delete objects in IPv4
pools

Description
The service ip_pool_admin_service_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

162
 IPv4 Pool

Name
group_pool_add — Add an IPv4 pool as group resource
Description
The service group_pool_add allows to add an object as resource for a group of users. You must
specify the group of users and the object that you set as resource. Once set as a resource, the
group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

163
 IPv4 Pool

Name
group_pool_delete — Remove an IPv4 pool from a group resources
Description
The service group_pool_delete allows to delete SOLIDserver database object. The service
group_pool_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

164
 IPv4 Pool

Name
ip_pool_delete — Delete an IPv4 pool
Description
The service ip_pool_delete allows to delete SOLIDserver database object. The service
ip_pool_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
start_addr
Pool start IP address.
end_addr
Pool end IP address.
pool_size
Pool size.
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_class_parameters
The pool_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by pool_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
pool_read_only
Pool is in read only mode.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.

165
 IPv4 Pool

add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

166
Chapter 16. IPv6 Pool

167
 IPv6 Pool

Name
ip6_pool6_add — Add/Edit an IPv6 pool
Description
The service ip6_pool6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
start_addr
Pool6 start IP address.
end_addr
Pool6 end IP address.
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_class_parameters
The pool6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by pool6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
pool6_read_only
Pool6 is in read only mode.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.

168
 IPv6 Pool

add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

169
 IPv6 Pool

Name
ip6_pool6_count — Number of IPv6 pools
Description
The service ip6_pool6_count allows to display the number of IPv6 pools.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: real_site_id, real_tree_path, real_hidden_site, hid-

den_site, tree_path, pool6_id, pool6_name, pool6_class_name, pool6_class_parameters,
pool6_read_only, start_ip6_addr, end_ip6_addr, scope_size, pool6_custom1, pool6_custom2,
pool6_custom3, site_name, site_id, block6_name, block6_id, vlsm_subnet6_id, subnet6_name,
vlsm_block6_id, subnet6_addr, subnet6_id, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3, par-
ent_site_name, block6_custom1, block6_custom2, block6_custom3, block6_scope_size,
block6_start_ip6_addr, block6_end_ip6_addr, subnet6_start_ip6_addr, subnet6_custom1,
subnet6_custom2, subnet6_custom3, pool6_size, pool6_start_ip6_addr,
pool6_end_ip6_addr, block6_class_name, block_path, block_level, block6_prefix, sub-
net6_class_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

170
 IPv6 Pool

Name
ip6_pool6_list — List the IPv6 pools
Description
The service ip6_pool6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: real_site_id, real_tree_path, real_hidden_site, hid-

den_site, tree_path, pool6_id, pool6_name, pool6_class_name, pool6_class_parameters,
pool6_read_only, start_ip6_addr, end_ip6_addr, scope_size, pool6_custom1, pool6_custom2,
pool6_custom3, site_name, site_id, block6_name, block6_id, vlsm_subnet6_id, subnet6_name,
vlsm_block6_id, subnet6_addr, subnet6_id, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3, par-
ent_site_name, block6_custom1, block6_custom2, block6_custom3, block6_scope_size,
block6_start_ip6_addr, block6_end_ip6_addr, subnet6_start_ip6_addr, subnet6_custom1,
subnet6_custom2, subnet6_custom3, pool6_size, pool6_start_ip6_addr,
pool6_end_ip6_addr, block6_class_name, block_path, block_level, block6_prefix, sub-
net6_class_name.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

171
 IPv6 Pool

pool6_id
The pool6_id parameter is the Pool6 identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
pool6_name
Pool6 name.
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_class_parameters
The pool6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by pool6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
pool6_read_only
Pool6 is in read only mode.
start_ip6_addr
First IP address of the range.
end_ip6_addr
Last IP address of the range.
scope_size
Size of the container either it is a block or a subnet.
site_name
site name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
block6_name
The IPv6 block name.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
subnet6_name
Subnet6 name.
subnet6_addr
Subnet6 start IP address.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names

172
 IPv6 Pool

are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
pool6_size
Not documented.
pool6_start_ip6_addr
Not documented.
pool6_end_ip6_addr
Not documented.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
block_path
Block path.
block_level
Block6 level.
block6_prefix
Block6 prefix.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.

173
 IPv6 Pool

Name
ip6_pool6_info — Display the properties of an IPv6 pool
Description
The service ip6_pool6_info returns the information on the object specified in input.

Input Parameters
pool6_id
The pool6_id parameter is the Pool6 identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
pool6_id
The pool6_id parameter is the Pool6 identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
pool6_name
Pool6 name.
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_class_parameters
The pool6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by pool6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
pool6_read_only
Pool6 is in read only mode.
start_ip6_addr
First IP address of the range.
end_ip6_addr
Last IP address of the range.
scope_size
Size of the container either it is a block or a subnet.
site_name
site name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

174
 IPv6 Pool

block6_name
The IPv6 block name.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
subnet6_name
Subnet6 name.
subnet6_addr
Subnet6 start IP address.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
pool6_size
Not documented.
pool6_start_ip6_addr
Not documented.
pool6_end_ip6_addr
Not documented.

175
 IPv6 Pool

block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
block_path
Block path.
block_level
Block6 level.
block6_prefix
Block6 prefix.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.

176
 IPv6 Pool

Name
ip6_pool6_name_list — List the name of the IPv4 pools and their configured classes
for a specific subnet

Description
The service ip6_pool6_name_list allows to the name and class configured on the pool of a spe-
cific IPv6 subnet. The rows returned to the user running the service depend on the resources
granted to the group they belong to. The WHERE input parameter allows to filter the returned
rows.

To execute this service, users must be granted permission to use it.

Input Parameters
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

177
 IPv6 Pool

Name
ip6_pool6_class_list — List of the classes configured and applied on IPv6 pools
Description
The service ip6_pool6_class_list allows to list all the classes configured and applied on IPv6
pools. The rows returned to the user running the service depend on the resources granted to the
group they belong to. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted permission to use it.

Input Parameters
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

178
 IPv6 Pool

Name
group_pool6_add — Add an IPv6 pool as group resource
Description
The service group_pool6_add allows to add an object as resource for a group of users.You must
specify the group of users and the object that you set as resource. Once set as a resource, the
group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

179
 IPv6 Pool

Name
group_pool6_delete — Remove an IPv6 pool from a group resources
Description
The service group_pool6_delete allows to delete SOLIDserver database object. The service
group_pool6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

180
 IPv6 Pool

Name
ip6_pool6_delete — Delete an IPv6 pool
Description
The service ip6_pool6_delete allows to delete SOLIDserver database object. The service
ip6_pool6_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
start_addr
Pool6 start IP address.
end_addr
Pool6 end IP address.
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_class_parameters
The pool6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by pool6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
pool6_read_only
Pool6 is in read only mode.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.

181
 IPv6 Pool

additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

182
Chapter 17. IPv4 Address

183
 IPv4 Address

Name
ip_add — Add/Edit an IPv4 address
Description
The service ip_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Name of the space where the address is directly connected.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
name
The name of the IP address (Obsolete. Has been replaced by ip_name).
ip_name
The fully qualified domain name (FQDN) of the IP address.
mac_addr
IP address MAC address.
ip_addr
Encoded hex IP address. (Obsolete. Has been replaced by ip_name).
hostaddr
IPv4 address in canonical representation with dot-decimal notation as 192.168.0.1.
ip_class_name
The ip_class_name is the name of the file class that will used for this object. The name of
ip_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip_class_name parameter
could be set to: my_favorite_dir/my_class.class.
ip_class_parameters
The ip_class_parameters parameter is a data container used to store your customized meta-
data. This meta-data can be apply for the class object definition and for the global customized
fields as well. The ip_class_parameters parameter accepts several meta-data values set in
the following URL style format: metadata1=value1&metadata2=value2&. To be accepted by
ip_class_parameters parameter the URL value must be encoded in URL format (see RFC
3986).

184
 IPv4 Address

keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

185
 IPv4 Address

Name
ip_address_count — Number of IPv4 addresses
Description
The service ip_address_count allows to display the number of IPv4 addresses.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip_free_ip_id, type, free_start_ip_addr,

free_end_ip_addr, free_scope_size, ip_id, site_is_template, root_site_id, hidden_site,
real_site_name, real_site_id, site_name, tree_level, tree_path, real_tree_path, block_name,
ip_addr, name, ip_custom1, ip_custom2, ip_custom3, mac_addr, ip_class_name, sub-
net_name, pool_name, site_id, subnet_id, subnet_start_ip_addr, subnet_end_ip_addr, sub-
net_scope_size, block_scope_size, block_id, vlsm_subnet_id, ip_class_parameters,
pool_class_name, pool_id, pool_read_only, pool_row_enabled, iplnetdev_name, iplnetdev_id,
iplport_name, iplport_slotnumber, iplport_portnumber, iplport_ifvlan, hostiface_name, hosti-
face_id, hostdev_name, hostdev_id, site_description, site_class_name, site_class_parameters,
row_enabled, site_custom1, site_custom2, site_custom3, parent_site_name,
block_class_name, scope_size, block_custom1, block_custom2, block_custom3,
block_start_ip_addr, block_end_ip_addr, vlsm_block_id, subnet_class_name, subnet_custom1,
subnet_custom2, subnet_custom3, pool_size, pool_start_ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

186
 IPv4 Address

Name
ip_address_list — List all the IPv4 addresses
Description
The service ip_address_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip_free_ip_id, type, free_start_ip_addr,

free_end_ip_addr, free_scope_size, ip_id, site_is_template, root_site_id, hidden_site,
real_site_name, real_site_id, site_name, tree_level, tree_path, real_tree_path, block_name,
ip_addr, name, ip_custom1, ip_custom2, ip_custom3, mac_addr, ip_class_name, sub-
net_name, pool_name, site_id, subnet_id, subnet_start_ip_addr, subnet_end_ip_addr, sub-
net_scope_size, block_scope_size, block_id, vlsm_subnet_id, ip_class_parameters,
pool_class_name, pool_id, pool_read_only, pool_row_enabled, iplnetdev_name, iplnetdev_id,
iplport_name, iplport_slotnumber, iplport_portnumber, iplport_ifvlan, hostiface_name, hosti-
face_id, hostdev_name, hostdev_id, site_description, site_class_name, site_class_parameters,
row_enabled, site_custom1, site_custom2, site_custom3, parent_site_name,
block_class_name, scope_size, block_custom1, block_custom2, block_custom3,
block_start_ip_addr, block_end_ip_addr, vlsm_block_id, subnet_class_name, subnet_custom1,
subnet_custom2, subnet_custom3, pool_size, pool_start_ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

187
 IPv4 Address

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ip_free_ip_id
Not documented.
free_start_ip_addr
Not documented.
free_end_ip_addr
Not documented.
free_scope_size
Not documented.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
site_is_template
Space is a template.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block_name
The IPv4 block name.
ip_addr
IP address.
name
Rule name.
mac_addr
IP address MAC address.
ip_class_name
The ip_class_name is the name of the file class that will used for this object. The name of
ip_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip_class_name parameter
could be set to: my_favorite_dir/my_class.class.
subnet_name
Subnet name.
pool_name
Pool name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

188
 IPv4 Address

subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_start_ip_addr
First IP address of the subnet.
subnet_end_ip_addr
Last IP address of the subnet.
subnet_scope_size
Size of the subnet (number of IP addresses).
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_class_parameters
The ip_class_parameters parameter is a data container used to store your customized meta-
data. This meta-data can be apply for the class object definition and for the global customized
fields as well. The ip_class_parameters parameter accepts several meta-data values set in
the following URL style format: metadata1=value1&metadata2=value2&. To be accepted by
ip_class_parameters parameter the URL value must be encoded in URL format (see RFC
3986).
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_read_only
Pool is in read only mode.
pool_row_enabled
Not documented.
iplnetdev_name
The network device name.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
iplport_name
Not documented.
iplport_slotnumber
Not documented.
iplport_portnumber
Not documented.
iplport_ifvlan
Not documented.

189
 IPv4 Address

hostiface_name
Not documented.
hostiface_id
Not documented.
hostdev_name
Not documented.
hostdev_id
Not documented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
scope_size
Size of the container either it is a block or a subnet.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
pool_size
Pool size.

190
 IPv4 Address

pool_start_ip_addr
Not documented.

191
 IPv4 Address

Name
ip_address_info — Display the properties of an IPv4 address
Description
The service ip_address_info returns the information on the request object identified by the ip_id
parameter.

Input Parameters
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ip_free_ip_id
Not documented.
free_start_ip_addr
Not documented.
free_end_ip_addr
Not documented.
free_scope_size
Not documented.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
site_is_template
Space is a template.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block_name
The IPv4 block name.
ip_addr
IP address.
name
Rule name.
mac_addr
IP address MAC address.

192
 IPv4 Address

ip_class_name
The ip_class_name is the name of the file class that will used for this object. The name of
ip_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip_class_name parameter
could be set to: my_favorite_dir/my_class.class.
subnet_name
Subnet name.
pool_name
Pool name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_start_ip_addr
First IP address of the subnet.
subnet_end_ip_addr
Last IP address of the subnet.
subnet_scope_size
Size of the subnet (number of IP addresses).
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_class_parameters
The ip_class_parameters parameter is a data container used to store your customized meta-
data. This meta-data can be apply for the class object definition and for the global customized
fields as well. The ip_class_parameters parameter accepts several meta-data values set in
the following URL style format: metadata1=value1&metadata2=value2&. To be accepted by
ip_class_parameters parameter the URL value must be encoded in URL format (see RFC
3986).
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_read_only
Pool is in read only mode.
pool_row_enabled
Not documented.
iplnetdev_name
The network device name.

193
 IPv4 Address

iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
iplport_name
Not documented.
iplport_slotnumber
Not documented.
iplport_portnumber
Not documented.
iplport_ifvlan
Not documented.
hostiface_name
Not documented.
hostiface_id
Not documented.
hostdev_name
Not documented.
hostdev_id
Not documented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
scope_size
Size of the container either it is a block or a subnet.

194
 IPv4 Address

block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
pool_size
Pool size.
pool_start_ip_addr
Not documented.

195
 IPv4 Address

Name
ip_find_free_address — Find free IPv4 addresses in any container
Description
The service ip_find_free_address allows to list the free IPv4 addresses in any container. The input
parameters define where to look. To execute this service, users must be granted permission to
use it. The rows returned to the user running the service depend on the resources granted to the
group they belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
subnet_path
Subnet path.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
ip_addr
IPv4 address.
site_id
Space identifier (ID).
site_name
Space name.
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

196
 IPv4 Address

Name
ip_free_ip_count — Number of free IPv4 addresses
Description
The service ip_free_ip_count allows to display t he number of free IPv4 addresses.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

197
 IPv4 Address

Name
ip_free_ip_list — List the free IPv4 addresses
Description
The service ip_free_ip_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

198
 IPv4 Address

Name
ip_used_subnet_address_count — Number of used IPv4 addresses
Description
The service ip_used_subnet_address_count allows to display the number of used IPv4 addresses.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip_id, ip_row_enabled, root_site_id, hidden_site,

real_site_name, real_site_id, site_name, tree_level, tree_path, real_tree_path, block_name,
ip_addr, name, ip_custom1, ip_custom2, ip_custom3, mac_addr, ip_class_name, sub-
net_name, pool_name, site_id, subnet_id, subnet_start_ip_addr, subnet_end_ip_addr, sub-
net_scope_size, block_scope_size, block_id, vlsm_subnet_id, ip_class_parameters,
pool_class_name, pool_class_parameters, pool_id, pool_read_only, pool_row_enabled, ipl-
netdev_name, iplnetdev_id, iplport_name, iplport_slotnumber, iplport_portnumber, ipl-
port_ifvlan, hostiface_name, hostiface_id, hostdev_name, hostdev_id, site_description,
site_class_name, site_class_parameters, row_enabled, site_row_enabled, site_custom1,
site_custom2, site_custom3, parent_site_name, block_class_name, block_class_parameters,
scope_size, block_custom1, block_custom2, block_custom3, block_start_ip_addr,
block_end_ip_addr, vlsm_block_id, subnet_class_name, subnet_custom1, subnet_custom2,
subnet_custom3, block_id, vlsm_block_id, pool_size, pool_start_ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

199
 IPv4 Address

Name
ip_used_subnet_address_list — List the used IPv4 addresses
Description
The service ip_used_subnet_address_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip_id, ip_row_enabled, root_site_id, hidden_site,

real_site_name, real_site_id, site_name, tree_level, tree_path, real_tree_path, block_name,
ip_addr, name, ip_custom1, ip_custom2, ip_custom3, mac_addr, ip_class_name, sub-
net_name, pool_name, site_id, subnet_id, subnet_start_ip_addr, subnet_end_ip_addr, sub-
net_scope_size, block_scope_size, block_id, vlsm_subnet_id, ip_class_parameters,
pool_class_name, pool_class_parameters, pool_id, pool_read_only, pool_row_enabled, ipl-
netdev_name, iplnetdev_id, iplport_name, iplport_slotnumber, iplport_portnumber, ipl-
port_ifvlan, hostiface_name, hostiface_id, hostdev_name, hostdev_id, site_description,
site_class_name, site_class_parameters, row_enabled, site_row_enabled, site_custom1,
site_custom2, site_custom3, parent_site_name, block_class_name, block_class_parameters,
scope_size, block_custom1, block_custom2, block_custom3, block_start_ip_addr,
block_end_ip_addr, vlsm_block_id, subnet_class_name, subnet_custom1, subnet_custom2,
subnet_custom3, block_id, vlsm_block_id, pool_size, pool_start_ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

200
 IPv4 Address

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_row_enabled
Not documented.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block_name
The IPv4 block name.
ip_addr
IP address.
name
Rule name.
mac_addr
IP address MAC address.
ip_class_name
The ip_class_name is the name of the file class that will used for this object. The name of
ip_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip_class_name parameter
could be set to: my_favorite_dir/my_class.class.
subnet_name
Subnet name.
pool_name
Pool name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_start_ip_addr
First IP address of the subnet.
subnet_end_ip_addr
Last IP address of the subnet.
subnet_scope_size
Size of the subnet (number of IP addresses).

201
 IPv4 Address

block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_class_parameters
The ip_class_parameters parameter is a data container used to store your customized meta-
data. This meta-data can be apply for the class object definition and for the global customized
fields as well. The ip_class_parameters parameter accepts several meta-data values set in
the following URL style format: metadata1=value1&metadata2=value2&. To be accepted by
ip_class_parameters parameter the URL value must be encoded in URL format (see RFC
3986).
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_class_parameters
The pool_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by pool_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_read_only
Pool is in read only mode.
pool_row_enabled
Not documented.
iplnetdev_name
The network device name.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
iplport_name
Not documented.
iplport_slotnumber
Not documented.
iplport_portnumber
Not documented.
iplport_ifvlan
Not documented.
hostiface_name
Not documented.

202
 IPv4 Address

hostiface_id
Not documented.
hostdev_name
Not documented.
hostdev_id
Not documented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
site_row_enabled
Not documented.
parent_site_name
Space parent name.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
block_class_parameters
The block_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by block_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
scope_size
Size of the container either it is a block or a subnet.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.

203
 IPv4 Address

subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_size
Pool size.
pool_start_ip_addr
Not documented.

204
 IPv4 Address

Name
ip_used_subnet_address_info — Display the properties of a used IPv4 address
Description
The service ip_used_subnet_address_info return the information on the object specified in input.

Input Parameters
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_row_enabled
Not documented.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block_name
The IPv4 block name.
ip_addr
IP address.
name
Rule name.
mac_addr
IP address MAC address.
ip_class_name
The ip_class_name is the name of the file class that will used for this object. The name of
ip_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip_class_name parameter
could be set to: my_favorite_dir/my_class.class.
subnet_name
Subnet name.
pool_name
Pool name.

205
 IPv4 Address

site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
subnet_id
The IPv4 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet_start_ip_addr
First IP address of the subnet.
subnet_end_ip_addr
Last IP address of the subnet.
subnet_scope_size
Size of the subnet (number of IP addresses).
block_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_class_parameters
The ip_class_parameters parameter is a data container used to store your customized meta-
data. This meta-data can be apply for the class object definition and for the global customized
fields as well. The ip_class_parameters parameter accepts several meta-data values set in
the following URL style format: metadata1=value1&metadata2=value2&. To be accepted by
ip_class_parameters parameter the URL value must be encoded in URL format (see RFC
3986).
pool_class_name
The pool_class_name is the name of the file class that will used for this object. The name of
pool_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a pool_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool_class_parameters
The pool_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The pool_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by pool_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
pool_id
The IPv4 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_read_only
Pool is in read only mode.
pool_row_enabled
Not documented.
iplnetdev_name
The network device name.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

206
 IPv4 Address

iplport_name
Not documented.
iplport_slotnumber
Not documented.
iplport_portnumber
Not documented.
iplport_ifvlan
Not documented.
hostiface_name
Not documented.
hostiface_id
Not documented.
hostdev_name
Not documented.
hostdev_id
Not documented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
site_row_enabled
Not documented.
parent_site_name
Space parent name.
block_class_name
The block_class_name is the name of the file class that will used for this object. The name
of block_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a block_class_name
parameter could be set to: my_favorite_dir/my_class.class.
block_class_parameters
The block_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The block_class_parameters parameter accepts several meta-

207
 IPv4 Address

data values set in the following URL style format: metadata1=value1&metadata2=value2&.

To be accepted by block_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
scope_size
Size of the container either it is a block or a subnet.
block_start_ip_addr
First IP address of the block. Could be used as the subnet container.
block_end_ip_addr
Last IP address of the block. Could be used as the subnet container.
subnet_class_name
The subnet_class_name is the name of the file class that will used for this object. The name
of subnet_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net_class_name parameter could be set to: my_favorite_dir/my_class.class.
block_id
The IPv4 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool_size
Pool size.
pool_start_ip_addr
Not documented.

208
 IPv4 Address

Name
ip_delete — Delete an IPv4 address
Description
The service ip_delete allows to delete SOLIDserver database object. The service ip_delete needs
to identify the object to delete with the input parameters detailed in the next section. This service
will be executed if the connected user running this service is allowed to delete the concerned
object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
name
IP address name.
ip_name
IP address name.
ip_addr
IP address.
hostaddr
IP address.
ip_class_name
The ip_class_name is the name of the file class that will used for this object. The name of
ip_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip_class_name parameter
could be set to: my_favorite_dir/my_class.class.
ip_class_parameters
The ip_class_parameters parameter is a data container used to store your customized meta-
data. This meta-data can be apply for the class object definition and for the global customized
fields as well. The ip_class_parameters parameter accepts several meta-data values set in
the following URL style format: metadata1=value1&metadata2=value2&. To be accepted by
ip_class_parameters parameter the URL value must be encoded in URL format (see RFC
3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.

209
 IPv4 Address

no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

210
Chapter 18. IPv6 Address

211
 IPv6 Address

Name
ip6_address6_add — Add/Edit an IPv6 address
Description
The service ip6_address6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
ip6_id
The ip6_id parameter is the IP6 address identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
ip6_name
IP6 address name.
ip6_mac_addr
IP6 address MAC address.
ip6_addr
IP6 address.
hostaddr
IP6 address.
ip6_class_name
The ip6_class_name is the name of the file class that will used for this object. The name of
ip6_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip6_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
ip6_class_parameters
The ip6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The ip6_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by ip6_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.

212
 IPv6 Address

add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

213
 IPv6 Address

Name
ip6_address6_count — Number of IPv6 addresses
Description
The service ip6_address6_count allows to display the number of IPv6 addresses.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip_free_ip6_id, type, free_start_ip6_addr,

free_end_ip6_addr, free_scope_size, ip6_id, root_site_id, hidden_site, real_site_name,
real_site_id, site_name, tree_level, tree_path, real_tree_path, block6_name, ip6_addr,
ip6_name, ip6_custom1, ip6_custom2, ip6_custom3, ip6_mac_addr, ip6_class_name, sub-
net6_name, pool6_name, site_id, subnet6_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr,
subnet6_scope_size, subnet6_prefix, block6_scope_size, block6_id, vlsm_subnet6_id,
ip6_class_parameters, pool6_class_name, pool6_id, pool6_read_only, pool6_row_enabled,
site_description, site_class_name, site_class_parameters, row_enabled, site_custom1,
site_custom2, site_custom3, parent_site_name, block6_class_name, scope_size,
block6_custom1, block6_custom2, block6_custom3, block6_prefix, block6_start_ip6_addr,
block6_end_ip6_addr, vlsm_block6_id, subnet6_class_name, subnet6_custom1, subnet6_cus-
tom2, subnet6_custom3, pool6_size, pool6_start_ip6_addr.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip_free_ip6_id, type, free_start_ip6_addr,

free_end_ip6_addr, free_scope_size, ip6_id, root_site_id, hidden_site, real_site_name,
real_site_id, site_name, tree_level, tree_path, real_tree_path, block6_name, ip6_addr,
ip6_name, ip6_custom1, ip6_custom2, ip6_custom3, ip6_mac_addr, ip6_class_name, sub-
net6_name, pool6_name, site_id, subnet6_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr,
subnet6_scope_size, subnet6_prefix, block6_scope_size, block6_id, vlsm_subnet6_id,
ip6_class_parameters, pool6_class_name, pool6_id, pool6_read_only, pool6_row_enabled,
site_description, site_class_name, site_class_parameters, row_enabled, site_custom1,
site_custom2, site_custom3, parent_site_name, block6_class_name, scope_size,
block6_custom1, block6_custom2, block6_custom3, block6_prefix, block6_start_ip6_addr,
block6_end_ip6_addr, vlsm_block6_id, subnet6_class_name, subnet6_custom1, subnet6_cus-
tom2, subnet6_custom3, pool6_size, pool6_start_ip6_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

214
 IPv6 Address

total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

215
 IPv6 Address

Name
ip6_address6_list — List all the IPv6 addresses
Description
The service ip6_address6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip_free_ip6_id, type, free_start_ip6_addr,

free_end_ip6_addr, free_scope_size, ip6_id, root_site_id, hidden_site, real_site_name,
real_site_id, site_name, tree_level, tree_path, real_tree_path, block6_name, ip6_addr,
ip6_name, ip6_custom1, ip6_custom2, ip6_custom3, ip6_mac_addr, ip6_class_name, sub-
net6_name, pool6_name, site_id, subnet6_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr,
subnet6_scope_size, subnet6_prefix, block6_scope_size, block6_id, vlsm_subnet6_id,
ip6_class_parameters, pool6_class_name, pool6_id, pool6_read_only, pool6_row_enabled,
site_description, site_class_name, site_class_parameters, row_enabled, site_custom1,
site_custom2, site_custom3, parent_site_name, block6_class_name, scope_size,
block6_custom1, block6_custom2, block6_custom3, block6_prefix, block6_start_ip6_addr,
block6_end_ip6_addr, vlsm_block6_id, subnet6_class_name, subnet6_custom1, subnet6_cus-
tom2, subnet6_custom3, pool6_size, pool6_start_ip6_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

216
 IPv6 Address

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ip_free_ip6_id
Not documented.
free_start_ip6_addr
Not documented.
free_end_ip6_addr
Not documented.
free_scope_size
Not documented.
ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block6_name
The IPv6 block name.
ip6_addr
IP6 address.
ip6_name
IP6 address name.
ip6_mac_addr
IP6 address MAC address.
ip6_class_name
The ip6_class_name is the name of the file class that will used for this object. The name of
ip6_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip6_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
subnet6_name
Subnet6 name.
pool6_name
Pool6 name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

217
 IPv6 Address

subnet6_start_ip6_addr
First IP v6 address of the subnet.
subnet6_end_ip6_addr
Last IP v6 address of the subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
subnet6_prefix
Subnet6 prefix.
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip6_class_parameters
The ip6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The ip6_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by ip6_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool6_read_only
Pool6 is in read only mode.
pool6_row_enabled
Not documented.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

218
 IPv6 Address

row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
scope_size
Size of the container either it is a block or a subnet.
block6_prefix
Block6 prefix.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
pool6_size
Not documented.
pool6_start_ip6_addr
Not documented.

219
 IPv6 Address

Name
ip6_address6_info — Display the properties of an IPv6 address
Description
The service ip6_address6_info returns the information on the object specified in input.

Input Parameters
ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

220
 IPv6 Address

Name
ip6_find_free_address6 — Find free IPv6 addresses
Description
The service ip6_find_free_address6 allows to list the free IPv6 addresses in any container. The
input parameters define where to look. To execute this service, users must be granted permission
to use it. The rows returned to the user running the service depend on the resources granted to
the group they belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
ip6_addr
IPv6 address.
site_id
Space identifier (ID).
site_name
Space name.
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

221
 IPv6 Address

Name
ip6_free_ip6_count — Number of free IPv6 addresses
Description
The service ip6_free_ip6_count allows to display the number of IPv6 addresses that can be as-
signed.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

222
 IPv6 Address

Name
ip6_free_ip6_list — List the free IPv6 addresses
Description
The service ip6_free_ip6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

223
 IPv6 Address

Name
ip6_used_subnet6_address_count — Number of used IPv6 addresses
Description
The service ip6_subnet6_address_count allows to display the number of used IPv6 addresses.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip6_id, root_site_id, hidden_site, real_site_name,

real_site_id, site_name, tree_level, tree_path, real_tree_path, block6_name, ip6_addr,
ip6_name, ip6_custom1, ip6_custom2, ip6_custom3, ip6_mac_addr, ip6_class_name, sub-
net6_name, pool6_name, site_id, subnet6_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr,
subnet6_scope_size, block6_scope_size, block6_id, vlsm_subnet6_id, ip6_class_parameters,
pool6_class_name, pool6_id, pool6_read_only, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3, par-
ent_site_name, block6_class_name, scope_size, block6_custom1, block6_custom2,
block6_custom3, block6_prefix, block6_start_ip6_addr, block6_end_ip6_addr, vlsm_block6_id,
subnet6_class_name, subnet6_custom1, subnet6_custom2, subnet6_custom3, pool6_size,
pool6_start_ip6_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

224
 IPv6 Address

Name
ip6_used_subnet6_address_list — List the used IPv6 addresses
Description
The service ip6_used_subnet6_address_list allows to list entries from SOLIDserver database.
To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ip6_id, root_site_id, hidden_site, real_site_name,

real_site_id, site_name, tree_level, tree_path, real_tree_path, block6_name, ip6_addr,
ip6_name, ip6_custom1, ip6_custom2, ip6_custom3, ip6_mac_addr, ip6_class_name, sub-
net6_name, pool6_name, site_id, subnet6_id, subnet6_start_ip6_addr, subnet6_end_ip6_addr,
subnet6_scope_size, block6_scope_size, block6_id, vlsm_subnet6_id, ip6_class_parameters,
pool6_class_name, pool6_id, pool6_read_only, site_description, site_class_name,
site_class_parameters, row_enabled, site_custom1, site_custom2, site_custom3, par-
ent_site_name, block6_class_name, scope_size, block6_custom1, block6_custom2,
block6_custom3, block6_prefix, block6_start_ip6_addr, block6_end_ip6_addr, vlsm_block6_id,
subnet6_class_name, subnet6_custom1, subnet6_custom2, subnet6_custom3, pool6_size,
pool6_start_ip6_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

225
 IPv6 Address

ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block6_name
The IPv6 block name.
ip6_addr
IP6 address.
ip6_name
IP6 address name.
ip6_mac_addr
IP6 address MAC address.
ip6_class_name
The ip6_class_name is the name of the file class that will used for this object. The name of
ip6_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip6_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
subnet6_name
Subnet6 name.
pool6_name
Pool6 name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
subnet6_end_ip6_addr
Last IP v6 address of the subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip6_class_parameters
The ip6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global

226
 IPv6 Address

customized fields as well. The ip6_class_parameters parameter accepts several meta-data

values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by ip6_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool6_read_only
Pool6 is in read only mode.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
scope_size
Size of the container either it is a block or a subnet.
block6_prefix
Block6 prefix.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.

227
 IPv6 Address

subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
pool6_size
Not documented.
pool6_start_ip6_addr
Not documented.

228
 IPv6 Address

Name
ip6_used_subnet6_address_info — Display the properties of a used IPv6 address
Description
The service ip6_used_subnet6_address_info return the information on the object specified in
input.

Input Parameters
ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
root_site_id
Root space ID in the IP address hierarchy.
site_name
site name.
tree_level
Depth of imbricated spaces.
block6_name
The IPv6 block name.
ip6_addr
IP6 address.
ip6_name
IP6 address name.
ip6_mac_addr
IP6 address MAC address.
ip6_class_name
The ip6_class_name is the name of the file class that will used for this object. The name of
ip6_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip6_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
subnet6_name
Subnet6 name.
pool6_name
Pool6 name.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

229
 IPv6 Address

subnet6_id
The IPv6 subnet identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
subnet6_start_ip6_addr
First IP v6 address of the subnet.
subnet6_end_ip6_addr
Last IP v6 address of the subnet.
subnet6_scope_size
Size of the subnet (number of IP addresses).
block6_scope_size
Size of the block (number of IP addresses). Could be used as the subnet container.
block6_id
The IPv6 block identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip6_class_parameters
The ip6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The ip6_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by ip6_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
pool6_class_name
The pool6_class_name is the name of the file class that will used for this object. The name
of pool6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a pool6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
pool6_id
The IPv6 pool identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
pool6_read_only
Pool6 is in read only mode.
site_description
Space description.
site_class_name
The site_class_name is the name of the file class that will used for this object. The name of
site_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a site_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
site_class_parameters
The site_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The site_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by site_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

230
 IPv6 Address

row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
parent_site_name
Space parent name.
block6_class_name
The block6_class_name is the name of the file class that will used for this object. The name
of block6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
block6_class_name parameter could be set to: my_favorite_dir/my_class.class.
scope_size
Size of the container either it is a block or a subnet.
block6_prefix
Block6 prefix.
block6_start_ip6_addr
First IP v6 address of the block. Could be used as the subnet container.
block6_end_ip6_addr
Last IP v6address of the block. Could be used as the subnet container.
subnet6_class_name
The subnet6_class_name is the name of the file class that will used for this object. The name
of subnet6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a sub-
net6_class_name parameter could be set to: my_favorite_dir/my_class.class.
pool6_size
Not documented.
pool6_start_ip6_addr
Not documented.

231
 IPv6 Address

Name
ip6_address6_delete — Delete an IPv6 address
Description
The service ip6_address6_delete allows to delete SOLIDserver database object. The service
ip6_address6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
ip6_id
The ip6_id parameter is the IP6 address identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
ip6_name
IP6 address name.
ip6_addr
IP6 address.
hostaddr
IP6 address.
ip6_class_name
The ip6_class_name is the name of the file class that will used for this object. The name of
ip6_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a ip6_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
ip6_class_parameters
The ip6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The ip6_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by ip6_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
additional_parameters
Additional parameters passed to rules.

232
 IPv6 Address

no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

233
Chapter 19. IPv4 Address Alias

234
 IPv4 Address Alias

Name
ip_alias_add — Add/Edit an IPv4 address alias
Description
The service ip_alias_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters List

site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_name
IP address alias.
ip_name_type
Specify the type of the resource record that will be configured in the DNS. The accepted
values are CNAME or A.
ip_addr
IP address.
hostaddr
IP address.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters List

errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

235
 IPv4 Address Alias

Name
ip_alias_list — List the IPv4 address aliases
Description
The service ip_alias_list allows to list all the IPv4 address aliases. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

To execute this service, users must be granted permission to use it.

Input Parameters
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

236
 IPv4 Address Alias

Name
ip_alias_delete — Delete an IPv4 address alias
Description
The service ip_alias_delete allows to delete SOLIDserver database object. The ip_alias_delete
service needs to identify the object to delete with the input parameters detailed in the next section.
This service will be executed if the connected user running this service is allowed to delete the
concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
ip_id
The IP address identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
ip_name_id
The ip_name_id parameter is the IP address alias identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
ip_name
IP address alias.
ip_addr
IP address.
hostaddr
IP address.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

237
Chapter 20. IPv6 Address Alias

238
 IPv6 Address Alias

Name
ip6_alias_add — Add/Edit an IPv6 address alias
Description
The service ip6_alias_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
ip6_id
The ip6_id parameter is the IP6 address identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
ip6_name
IP6 address alias.
ip_name_type
Specify the type of the resource record that will be configured in the DNS. The accepted
values are CNAME or AAAA.
ip6_addr
IP6 address.
hostaddr
IP6 address.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

239
 IPv6 Address Alias

Name
ip6_alias_list — List the IPv6 address alias
Description
The service ip6_alias_list allows to list all the IPv4 address aliases. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

To execute this service, users must be granted permission to use it.

Input Parameters
ip6_id
The ip6_id parameter is the IP address identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

240
 IPv6 Address Alias

Name
ip6_alias_delete — Delete an IPv6 address alias
Description
The service ip6_alias_delete allows to delete SOLIDserver database object. The ip6_alias_delete
service needs to identify the object to delete with the input parameters detailed in the next section.
This service will be executed if the connected user running this service is allowed to delete the
concerned object

Input Parameters
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
Space name.
ip6_id
The ip6_id parameter is the IP6 address identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
ip6_name_id
The ip6_name_id parameter is the IP6 address alias identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
ip6_name
IP6 address alias.
ip6_addr
IP6 address.
hostaddr
IP6 address.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

241
Part IV. DHCP Services
Table of Contents
21. DHCPv4 Server ....................................................................................................... 247
dhcp_add ............................................................................................................. 248
dhcp_server_count ................................................................................................ 251
dhcp_server_list .................................................................................................... 252
dhcp_server_info ................................................................................................... 256
dhcp46_server46_count ........................................................................................ 259
dhcp46_server46_list ............................................................................................ 260
dhcp46_server46_info ........................................................................................... 264
dhcp_server_options_list ....................................................................................... 267
dhcp_server_admin_group_count .......................................................................... 268
dhcp_server_admin_group_list ............................................................................... 269
dhcp_server_admin_service_count ........................................................................ 271
dhcp_server_admin_service_list ............................................................................ 272
group_dhcp_add ................................................................................................... 273
group_dhcp_delete ................................................................................................ 274
dhcp_delete .......................................................................................................... 275
22. DHCPv6 Server ....................................................................................................... 276
dhcp6_add ............................................................................................................ 277
dhcp6_server6_count ............................................................................................ 279
dhcp6_server6_list ................................................................................................ 280
dhcp6_server6_info ............................................................................................... 283
dhcp46_server46_count ........................................................................................ 286
dhcp46_server46_list ............................................................................................ 287
dhcp46_server46_info ........................................................................................... 291
dhcp6_server6_options6_list .................................................................................. 294
dhcp6_server6_admin_group_count ....................................................................... 295
dhcp6_server6_admin_group_list ........................................................................... 296
dhcp6_server6_admin_service_count ..................................................................... 298
dhcp6_server6_admin_service_list ......................................................................... 299
group_dhcp6_add ................................................................................................. 300
group_dhcp6_delete .............................................................................................. 301
dhcp6_delete ........................................................................................................ 302
23. DHCPv4 Group ........................................................................................................ 303
dhcp_group_add ................................................................................................... 304
dhcp_group_count ................................................................................................. 306
dhcp_group_list ..................................................................................................... 307
dhcp_group_info ................................................................................................... 309
dhcp_group_options_list ........................................................................................ 310
dhcp_group_delete ................................................................................................ 311
24. DHCPv6 Group ........................................................................................................ 312
dhcp6_group6_add ............................................................................................... 313
dhcp6_group6_count ............................................................................................. 315
dhcp6_group6_list ................................................................................................. 316
dhcp6_group6_info ................................................................................................ 318
dhcp6_group6_options6_list .................................................................................. 319
dhcp6_group6_delete ............................................................................................ 320
25. DHCPv4 Scope ....................................................................................................... 321
dhcp_scope_add ................................................................................................... 322
dhcp_scope_count ................................................................................................ 324
dhcp_scope_list .................................................................................................... 325
dhcp_scope_info ................................................................................................... 328

243
 DHCP Services

dhcp_scope_options_list ........................................................................................ 330

dhcp_scope_admin_group_count ........................................................................... 331
dhcp_scope_admin_group_list ............................................................................... 332
dhcp_scope_admin_service_count ......................................................................... 334
dhcp_scope_admin_service_list ............................................................................. 335
group_dhcpscope_add .......................................................................................... 336
group_dhcpscope_delete ....................................................................................... 337
dhcp_scope_delete ............................................................................................... 338
26. DHCPv6 Scope ....................................................................................................... 339
dhcp6_scope6_add ............................................................................................... 340
dhcp6_scope6_count ............................................................................................ 342
dhcp6_scope6_list ................................................................................................ 343
dhcp6_scope6_info ............................................................................................... 346
dhcp6_scope6_options6_list .................................................................................. 348
dhcp6_scope6_admin_group_count ....................................................................... 349
dhcp6_scope6_admin_group_list ........................................................................... 350
dhcp6_scope6_admin_service_count ..................................................................... 352
dhcp6_scope6_admin_service_list ......................................................................... 353
group_dhcpscope6_add ........................................................................................ 354
group_dhcpscope6_delete ..................................................................................... 355
dhcp6_scope6_delete ........................................................................................... 356
27. DHCPv4 Shared Network ......................................................................................... 357
dhcp_sn_add ........................................................................................................ 358
dhcp_shared_network_count ................................................................................. 360
dhcp_shared_network_list ..................................................................................... 361
dhcp_shared_network_info .................................................................................... 363
28. DHCPv6 Shared Network ......................................................................................... 364
dhcp6_sn6_add .................................................................................................... 365
dhcp6_shared_network6_count .............................................................................. 367
dhcp6_shared_network6_list .................................................................................. 368
dhcp6_shared_network6_info ................................................................................ 370
29. DHCPv4 Range ....................................................................................................... 371
dhcp_range_add ................................................................................................... 372
dhcp_range_count ................................................................................................. 374
dhcp_range_list ..................................................................................................... 375
dhcp_range_info ................................................................................................... 378
dhcp_range_options_list ........................................................................................ 381
dhcp_range_delete ................................................................................................ 382
30. DHCPv6 Range ....................................................................................................... 384
dhcp6_range6_add ............................................................................................... 385
dhcp6_range6_count ............................................................................................. 387
dhcp6_range6_list ................................................................................................. 388
dhcp6_range6_info ................................................................................................ 391
dhcp6_range6_options6_list .................................................................................. 393
dhcp6_range6_delete ............................................................................................ 394
31. DHCPv4 Lease ........................................................................................................ 395
dhcp_range_lease_count ....................................................................................... 396
dhcp_range_lease_list ........................................................................................... 397
dhcp_range_lease_info .......................................................................................... 400
dhcp_lease_log_count ........................................................................................... 403
dhcp_lease_log_list ............................................................................................... 404
dhcp_lease_delete ................................................................................................ 406
dhcp_lease_manual_delete ................................................................................... 407
32. DHCPv6 Lease ........................................................................................................ 408

244
 DHCP Services

dhcp6_lease6_count ............................................................................................. 409

dhcp6_lease6_list ................................................................................................. 410
dhcp6_lease6_info ................................................................................................ 413
dhcp6_lease6_log_count ....................................................................................... 416
dhcp6_lease6_log_list ........................................................................................... 417
dhcp6_lease6_delete ............................................................................................ 419
dhcp6_lease6_manual_delete ................................................................................ 420
33. DHCPv4 Static ......................................................................................................... 421
dhcp_static_add .................................................................................................... 422
dhcp_static_count ................................................................................................. 425
dhcp_static_list ..................................................................................................... 426
dhcp_static_info .................................................................................................... 429
dhcp_static_options_list ......................................................................................... 432
dhcp_static_delete ................................................................................................ 433
34. DHCPv6 Static ......................................................................................................... 435
dhcp6_static6_add ................................................................................................ 436
dhcp6_static6_count .............................................................................................. 439
dhcp6_static6_list .................................................................................................. 440
dhcp6_static6_info ................................................................................................ 443
dhcp6_static6_options6_list ................................................................................... 445
dhcp6_static6_delete ............................................................................................. 446
35. DHCPv4 Options ..................................................................................................... 448
dhcp_option_add ................................................................................................... 449
36. DHCPv6 Options ..................................................................................................... 452
dhcp6_option6_add ............................................................................................... 453
37. DHCPv4 Optiondef .................................................................................................. 456
dhcp_optiondef_add .............................................................................................. 457
dhcp_optiondef_count ........................................................................................... 459
dhcp_optiondef_list ............................................................................................... 460
dhcp_optiondef_info .............................................................................................. 462
dhcp_optiondef_delete .......................................................................................... 463
38. DHCPv6 Optiondef .................................................................................................. 464
dhcp6_optiondef6_add .......................................................................................... 465
dhcp6_optiondef6_count ........................................................................................ 467
dhcp6_optiondef6_list ............................................................................................ 468
dhcp6_optiondef6_info .......................................................................................... 470
dhcp6_optiondef6_delete ....................................................................................... 471
39. DHCPv4 ACL and ACL Entries ................................................................................. 472
dhcp_acl_add ....................................................................................................... 473
dhcp_acl_delete .................................................................................................... 475
dhcp_acl_data_add ............................................................................................... 476
dhcp_acl_data_delete ........................................................................................... 478
dhcp_class_count ................................................................................................. 479
dhcp_class_list ..................................................................................................... 480
dhcp_class_info .................................................................................................... 482
dhcp_class_options_list ......................................................................................... 483
dhcp_subclass_count ............................................................................................ 484
dhcp_subclass_list ................................................................................................ 485
dhcp_subclass_info ............................................................................................... 487
dhcp_subclass_options_list .................................................................................... 488
40. DHCPv4 Failover ..................................................................................................... 489
dhcp_failover_add ................................................................................................. 490
dhcp_failover_count .............................................................................................. 492
dhcp_failover_list ................................................................................................... 493

245
 DHCP Services

dhcp_failover_server_list ....................................................................................... 495

dhcp_failover_info ................................................................................................. 496
dhcp_failover_set_partner_down ............................................................................ 498
dhcp_failover_delete .............................................................................................. 499
41. DHCPv6 Failover ..................................................................................................... 500
dhcp6_failover6_add ............................................................................................. 501
dhcp6_failover6_count ........................................................................................... 503
dhcp6_failover6_list ............................................................................................... 504
dhcp6_failover6_server6_list .................................................................................. 506
dhcp6_failover6_info .............................................................................................. 507
dhcp6_failover6_delete .......................................................................................... 508

246
Chapter 21. DHCPv4 Server

247
 DHCPv4 Server

Name
dhcp_add — Add/Edit a DHCPv4 server
Description
The service dhcp_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcp_type
DHCP server type.
vdhcp_arch
VDHCP architecture (VDHCP).
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
vdhcp_param1
VDHCP param1 (VDHCP).
dhcp_dcs_key
DHCP DCS CC key (dcs).
dcs_key
DHCP DCS CC key (dcs).
cisco_login
DHCP Cisco login (cisco).
cisco_password
DHCP Cisco password (cisco).
cisco_root_password
DHCP Cisco root password (cisco).
cisco_use_ssh
DHCP Cisco use SSH.

248
 DHCPv4 Server

snmp_port
SNMP port (ipm).
snmp_profile_id
SNMP profile ID (ipm).
snmp_retry
SNMP retry (ipm).
snmp_timeout
SNMP timeout (ipm).
snmp_use_tcp
SNMP use tcp (ipm).
windhcp_port
TCP port (windhcp).
ms_use_ssl
Windhcp use SSL (windhcp).
windhcp_use_ssl
Windhcp use SSL (windhcp).
windhcp_protocol
Use SOAP or Plain text for WinDHCP protocol.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_parameters
The dhcp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dhcp_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
failover_list
DHCP server failover list.

249
 DHCPv4 Server

ipmdhcp_protocol
IPM DHCP protocol.
ipmdhcp_https_login
IPM DHCP https login.
ipmdhcp_https_password
IPM DHCP https password.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

250
 DHCPv4 Server

Name
dhcp_server_count — Number of DHCPv4 servers
Description
The service dhcp_server_count allows to display the number of DHCPv4 servers.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ipmdhcp_protocol, ipmdhcp_https_login, ipmdhcp_ht-

tps_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1, tcp_port, ms_use_ssl,
windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry, snmp_timeout, sn-
mp_use_tcp, cisco_use_ssh, cisco_login, cisco_password, cisco_root_password, ref1_dh-
cp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdhcp_ref2_dhcp_id, tree_level,
total_vdhcp_members, vdhcp_members_name, vdhcp_arch, vdhcp_parent_name, vdhcp_par-
ent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdhcp_ref1_dhcp_id, vdhcp_ref2_dh-
cp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id, dhcp_type, site_name, dhcp_state,
dhcp_synching, dhcp_name, dhcp_comment, dhcp_version, row_enabled, dhcp_custom1,
dhcp_custom2, dhcp_custom3, dhcp_class_name, dhcp_class_parameters, ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

251
 DHCPv4 Server

Name
dhcp_server_list — List the DHCPv4 servers
Description
The service dhcp_server_list allows to list data from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ipmdhcp_protocol, ipmdhcp_https_login, ipmdhcp_ht-

tps_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1, tcp_port, ms_use_ssl,
windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry, snmp_timeout, sn-
mp_use_tcp, cisco_use_ssh, cisco_login, cisco_password, cisco_root_password, ref1_dh-
cp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdhcp_ref2_dhcp_id, tree_level,
total_vdhcp_members, vdhcp_members_name, vdhcp_arch, vdhcp_parent_name, vdhcp_par-
ent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdhcp_ref1_dhcp_id, vdhcp_ref2_dh-
cp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id, dhcp_type, site_name, dhcp_state,
dhcp_synching, dhcp_name, dhcp_comment, dhcp_version, row_enabled, dhcp_custom1,
dhcp_custom2, dhcp_custom3, dhcp_class_name, dhcp_class_parameters, ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

252
 DHCPv4 Server

ipmdhcp_protocol
IPM DHCP protocol.
ipmdhcp_https_login
IPM DHCP https login.
ipmdhcp_https_password
IPM DHCP https password.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
dhcp_dcs_key
DHCP DCS CC key (dcs).
vdhcp_param1
VDHCP param1 (VDHCP).
tcp_port
Not documented.
ms_use_ssl
Windhcp use SSL (windhcp).
windhcp_protocol
Not documented.
snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
snmp_port
SNMP port.
snmp_profile_id
The snmp_profile_id parameter is the SNMP profile identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
snmp_retry
SNMP retry (ipm).
snmp_timeout
Timeout (seconds).
snmp_use_tcp
Use TCP transport.
cisco_use_ssh
DHCP Cisco use SSH.
cisco_login
DHCP Cisco login (cisco).
cisco_password
DHCP Cisco password (cisco).
cisco_root_password
DHCP Cisco root password (cisco).
ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).

253
 DHCPv4 Server

ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
tree_level
Depth of imbricated spaces.
total_vdhcp_members
Not documented.
vdhcp_members_name
Not documented.
vdhcp_arch
VDHCP architecture (VDHCP).
vdhcp_parent_name
Not documented.
vdhcp_parent_arch
Not documented.
vdhcp_parent_id
Not documented.
vdhcp_ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
vdhcp_ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
dhcp_uboottime
Time at which the DHCP service started for the last time, in UTC format.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_type
DHCP server type.
site_name
site name.
dhcp_state
Not documented.
dhcp_synching
Not documented.
dhcp_name
DHCP server name.
dhcp_comment
Not documented.
dhcp_version
Not documented.

254
 DHCPv4 Server

row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_parameters
The dhcp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dhcp_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
ip_addr
IP address.

255
 DHCPv4 Server

Name
dhcp_server_info — Display the properties of a DHCPv4 server
Description
The service dhcp_server_info returns the information on the object specified in input.

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp_localtime
The DHCP server local time.
msrpc_login
The AD login used to manage the server.
msrpc_password
The AD password used to manage the server.
msrpc_domain
The the name of the AD domain used to manage the server.
ipmdhcp_protocol
IPM DHCP protocol.
ipmdhcp_https_login
IPM DHCP https login.
ipmdhcp_https_password
IPM DHCP https password.
isolated
If the server is isolated, it does not execute the default behaviors.
dhcp_dcs_key
DHCP DCS CC key (dcs).
vdhcp_param1
VDHCP param1 (VDHCP).
tcp_port
Not documented.
ms_use_ssl
Windhcp use SSL (windhcp).
windhcp_protocol
Not documented.
snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

256
 DHCPv4 Server

snmp_port
SNMP port.
snmp_profile_id
The snmp_profile_id parameter is the SNMP profile identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
snmp_retry
SNMP retry (ipm).
snmp_timeout
Timeout (seconds).
snmp_use_tcp
Use TCP transport.
cisco_use_ssh
DHCP Cisco use SSH.
cisco_login
DHCP Cisco login (cisco).
cisco_password
DHCP Cisco password (cisco).
cisco_root_password
DHCP Cisco root password (cisco).
ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
tree_level
Depth of imbricated spaces.
total_vdhcp_members
Not documented.
vdhcp_members_name
Not documented.
vdhcp_arch
VDHCP architecture (VDHCP).
vdhcp_parent_name
Not documented.
vdhcp_parent_arch
Not documented.
vdhcp_parent_id
Not documented.
vdhcp_ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).

257
 DHCPv4 Server

vdhcp_ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
dhcp_uboottime
Time at which the DHCP service started for the last time, in UTC format.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_type
DHCP server type.
site_name
Name of the IPAM space associated with the server.
dhcp_state
DHCP server status.
dhcp_synching
Server synchronization status.
dhcp_name
DHCP server name.
dhcp_comment
DHCP server description.
dhcp_version
DHCP server version.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_parameters
The dhcp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dhcp_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
ip_addr
The server IP address.
dhcp_last_refresh_time
EfficientIP DHCP servers last synchronization time, in UTC format.

258
 DHCPv4 Server

Name
dhcp46_server46_count — Number of DHCPv4 and DHCPv6 servers in the database
Description
The service dhcp46_server46_count returns the number of DHCPv4 and DHCPv6 servers in the
database. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp46_id, dhcp_id, type, ipmdhcp_protocol, ipmdh-
cp_https_login, ipmdhcp_https_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1,
tcp_port, ms_use_ssl, windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry,
snmp_timeout, snmp_use_tcp, cisco_use_ssh, cisco_login, cisco_password,
cisco_root_password, ref1_dhcp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdh-
cp_ref2_dhcp_id, tree_level, total_vdhcp_members, vdhcp_members_name, vdhcp_arch,
vdhcp_parent_name, vdhcp_parent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdh-
cp_ref1_dhcp_id, vdhcp_ref2_dhcp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id,
dhcp_type, site_name, dhcp_state, dhcp_synching, dhcp_name, dhcp_comment, dhcp_ver-
sion, row_enabled, dhcp_custom1, dhcp_custom2, dhcp_custom3, dhcp_class_name, dh-
cp_class_parameters, ip_addr.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp46_id, dhcp_id, type, ipmdhcp_protocol, ipmdh-
cp_https_login, ipmdhcp_https_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1,
tcp_port, ms_use_ssl, windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry,
snmp_timeout, snmp_use_tcp, cisco_use_ssh, cisco_login, cisco_password,
cisco_root_password, ref1_dhcp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdh-
cp_ref2_dhcp_id, tree_level, total_vdhcp_members, vdhcp_members_name, vdhcp_arch,
vdhcp_parent_name, vdhcp_parent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdh-
cp_ref1_dhcp_id, vdhcp_ref2_dhcp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id,
dhcp_type, site_name, dhcp_state, dhcp_synching, dhcp_name, dhcp_comment, dhcp_ver-
sion, row_enabled, dhcp_custom1, dhcp_custom2, dhcp_custom3, dhcp_class_name, dh-
cp_class_parameters, ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

259
 DHCPv4 Server

Name
dhcp46_server46_list — List the DHCPv4 and DHCPv6 servers in the database
Description
The service dhcp46_server46_list allows to list the DHCPv4 and DHCPv6 servers in the database.
The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp46_id, dhcp_id, type, ipmdhcp_protocol, ipmdh-
cp_https_login, ipmdhcp_https_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1,
tcp_port, ms_use_ssl, windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry,
snmp_timeout, snmp_use_tcp, cisco_use_ssh, cisco_login, cisco_password,
cisco_root_password, ref1_dhcp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdh-
cp_ref2_dhcp_id, tree_level, total_vdhcp_members, vdhcp_members_name, vdhcp_arch,
vdhcp_parent_name, vdhcp_parent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdh-
cp_ref1_dhcp_id, vdhcp_ref2_dhcp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id,
dhcp_type, site_name, dhcp_state, dhcp_synching, dhcp_name, dhcp_comment, dhcp_ver-
sion, row_enabled, dhcp_custom1, dhcp_custom2, dhcp_custom3, dhcp_class_name, dh-
cp_class_parameters, ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

260
 DHCPv4 Server

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp46_id
The DHCP server unique identifier (ID) within the DHCPv4/DHCPv6 database.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
ipmdhcp_protocol
IPM DHCP protocol.
ipmdhcp_https_login
IPM DHCP https login.
ipmdhcp_https_password
IPM DHCP https password.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
dhcp_dcs_key
DHCP DCS CC key (dcs).
vdhcp_param1
VDHCP param1 (VDHCP).
tcp_port
Not documented.
ms_use_ssl
Windhcp use SSL (windhcp).
windhcp_protocol
Not documented.
snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
snmp_port
SNMP port.
snmp_profile_id
The snmp_profile_id parameter is the SNMP profile identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
snmp_retry
SNMP retry (ipm).
snmp_timeout
Timeout (seconds).
snmp_use_tcp
Use TCP transport.
cisco_use_ssh
DHCP Cisco use SSH.

261
 DHCPv4 Server

cisco_login
DHCP Cisco login (cisco).
cisco_password
DHCP Cisco password (cisco).
cisco_root_password
DHCP Cisco root password (cisco).
ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
tree_level
Depth of imbricated spaces.
total_vdhcp_members
Not documented.
vdhcp_members_name
Not documented.
vdhcp_arch
VDHCP architecture (VDHCP).
vdhcp_parent_name
Not documented.
vdhcp_parent_arch
Not documented.
vdhcp_parent_id
Not documented.
vdhcp_ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
vdhcp_ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
dhcp_uboottime
Time at which the DHCP service started for the last time, in UTC format.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
site_name
site name.

262
 DHCPv4 Server

dhcp_state
Not documented.
dhcp_synching
Not documented.
dhcp_name
DHCP server name.
dhcp_comment
Not documented.
dhcp_version
Not documented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_parameters
The dhcp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dhcp_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
ip_addr
IP address.

263
 DHCPv4 Server

Name
dhcp46_server46_info — Display the properties of a DHCPv4 or DHCPv6 server
Description
The service dhcp46_server46_info allows to display the properties of the DHCP server specified,
whether DHCPv4 or DHCPv6. For this service, the dhcp_id input parameter accepts the identifier
of a DHCPv4 or a DHCPv6 server.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
dhcp_id
The DHCP server identifier (ID). For the service dhcp46_server46_info, the dhcp_id accepts
the identifier of any DHCP server, whether a DHCPv4 or a DHCPv6 server. This identifier is
a unique numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp46_id
The DHCP server unique identifier (ID) within the DHCPv4/DHCPv6 database.
dhcp_id
The DHCP server identifier (ID). For the service dhcp46_server46_info, the dhcp_id returns
the identifier of any DHCP server, whether a DHCPv4 or a DHCPv6 server. This identifier is
a unique numeric key value that is automatically incremented.
ipmdhcp_protocol
IPM DHCP protocol.
ipmdhcp_https_login
IPM DHCP https login.
ipmdhcp_https_password
IPM DHCP https password.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
dhcp_dcs_key
DHCP DCS CC key (dcs).
vdhcp_param1
VDHCP param1 (VDHCP).
tcp_port
Not documented.
ms_use_ssl
Windhcp use SSL (windhcp).
windhcp_protocol
Not documented.

264
 DHCPv4 Server

snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
snmp_port
SNMP port.
snmp_profile_id
The snmp_profile_id parameter is the SNMP profile identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
snmp_retry
SNMP retry (ipm).
snmp_timeout
Timeout (seconds).
snmp_use_tcp
Use TCP transport.
cisco_use_ssh
DHCP Cisco use SSH.
cisco_login
DHCP Cisco login (cisco).
cisco_password
DHCP Cisco password (cisco).
cisco_root_password
DHCP Cisco root password (cisco).
ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
tree_level
Depth of imbricated spaces.
total_vdhcp_members
Not documented.
vdhcp_members_name
Not documented.
vdhcp_arch
VDHCP architecture (VDHCP).
vdhcp_parent_name
Not documented.
vdhcp_parent_arch
Not documented.
vdhcp_parent_id
Not documented.

265
 DHCPv4 Server

vdhcp_ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
vdhcp_ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
dhcp_uboottime
Time at which the DHCP service started for the last time, in UTC format.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
site_name
site name.
dhcp_state
Not documented.
dhcp_synching
Not documented.
dhcp_name
DHCP server name.
dhcp_comment
Not documented.
dhcp_version
Not documented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_parameters
The dhcp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dhcp_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
ip_addr
IP address.

266
 DHCPv4 Server

Name
dhcp_server_options_list — List the DHCP options set on a DHCPv4 server
Description
The service dhcp_server_options_list allows to list entries from SOLIDserver database.To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

267
 DHCPv4 Server

Name
dhcp_server_admin_group_count — Total number of groups that can access
the DHCPv4 server list

Description
The service dhcp_server_admin_group_count allows to display the total number of groups of
users that can access the DHCPv4 server list. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

268
 DHCPv4 Server

Name
dhcp_server_admin_group_list — List all the groups that can access the DHCPv4
server list

Description
The service dhcp_server_admin_group_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.

269
 DHCPv4 Server

grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

270
 DHCPv4 Server

Name
dhcp_server_admin_service_count — Total number of rights for a group to
add/delete objects in a DHCPv4 server

Description
The service dhcp_server_admin_service_count allows to display the total number of rights for a
group of users to add/delete objects in a DHCPv4 server. The rows returned to the user running
the service are not subject to the group resources, this service returns data as if the user running
it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

271
 DHCPv4 Server

Name
dhcp_server_admin_service_list — List all the rights of a group to add/delete
objects in a DHCPv4 server

Description
The service dhcp_server_admin_service_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

272
 DHCPv4 Server

Name
group_dhcp_add — Add a DHCPv4 server as group resource
Description
The service group_dhcp_add allows to add an object as resource for a group of users. You must
specify the group of users and the object that you set as resource. Once set as a resource, the
group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

273
 DHCPv4 Server

Name
group_dhcp_delete — Remove a DHCPv4 server from a group resources
Description
The service group_dhcp_delete allows to delete SOLIDserver database object. The service
group_dhcp_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

274
 DHCPv4 Server

Name
dhcp_delete — Delete a DHCPv4 server
Description
The service dhcp_delete allows to delete SOLIDserver database object. The service dhcp_delete
needs to identify the object to delete with the input parameters detailed in the next section. This
service will be executed if the connected user running this service is allowed to delete the con-
cerned object

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

275
Chapter 22. DHCPv6 Server

276
 DHCPv6 Server

Name
dhcp6_add — Add/Edit a DHCPv6 server
Description
The service dhcp6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID) used to join foreign data. This
identifier is a unique numeric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
dhcp6_type
DHCPv6 server type.
vdhcp6_arch
The DHCPv6 architecture type, either single for Single-Server, splitscope for Split-Scope or
stateless for Stateless.
vdhcp6_ref1_dhcp6_id
VDHCPv6 ref1 DHCPv6 ID (VDHCPv6).
vdhcp6_ref2_dhcp6_id
VDHCPv6 ref2 DHCPv6 ID (VDHCPv6).
vdhcp6_param1
VDHCPv6 param1 (VDHCPv6).
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_parameters
The dhcp6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dhcp6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).

277
 DHCPv6 Server

keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
failover_list
DHCP server failover list.
ipmdhcp6_https_login
IPM DHCPv6 https login.
ipmdhcp6_https_password
IPM DHCPv6 https password.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

278
 DHCPv6 Server

Name
dhcp6_server6_count — Number of DHCPv6 servers
Description
The service dhcp6_server6_count allows to list all the DHCPv6 servers of the database. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ipmdhcp6_https_login, ipmdhcp6_https_password,

isolated, tree_path, vdhcp6_param1, ref1_dhcp6_name, vdhcp6_ref1_dhcp6_id, ref2_dh-
cp6_name, vdhcp6_ref2_dhcp6_id, tree_level, total_vdhcp6_members, vdhcp6_mem-
bers_name, vdhcp6_arch, vdhcp6_parent_name, vdhcp6_parent_arch, vdhcp6_parent_id,
vdhcp6_ref1_dhcp6_name, vdhcp6_ref1_dhcp6_id, vdhcp6_ref2_dhcp6_name, vdh-
cp6_ref2_dhcp6_id, dhcp6_uboottime, dhcp6_id, dhcp6_type, site_name, dhcp6_state, dh-
cp6_synching, dhcp6_name, dhcp6_comment, dhcp6_version, row_enabled, dh-
cp6_class_name, dhcp6_class_parameters, ip6_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

279
 DHCPv6 Server

Name
dhcp6_server6_list — List the DHCPv6 servers
Description
The service dhcp6_server6_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use the service dhcp6_server6_list. The rows
returned to the user running the service depend on the resources granted to the group they belong
to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: ipmdhcp6_https_login, ipmdhcp6_https_password,

isolated, tree_path, vdhcp6_param1, ref1_dhcp6_name, vdhcp6_ref1_dhcp6_id, ref2_dh-
cp6_name, vdhcp6_ref2_dhcp6_id, tree_level, total_vdhcp6_members, vdhcp6_mem-
bers_name, vdhcp6_arch, vdhcp6_parent_name, vdhcp6_parent_arch, vdhcp6_parent_id,
vdhcp6_ref1_dhcp6_name, vdhcp6_ref1_dhcp6_id, vdhcp6_ref2_dhcp6_name, vdh-
cp6_ref2_dhcp6_id, dhcp6_uboottime, dhcp6_id, dhcp6_type, site_name, dhcp6_state, dh-
cp6_synching, dhcp6_name, dhcp6_comment, dhcp6_version, row_enabled, dh-
cp6_class_name, dhcp6_class_parameters, ip6_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ipmdhcp6_https_login
Not documented.

280
 DHCPv6 Server

ipmdhcp6_https_password
Not documented.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
vdhcp6_param1
Not documented.
ref1_dhcp6_name
Not documented.
vdhcp6_ref1_dhcp6_id
Not documented.
ref2_dhcp6_name
Not documented.
vdhcp6_ref2_dhcp6_id
Not documented.
tree_level
Depth of imbricated spaces.
total_vdhcp6_members
Not documented.
vdhcp6_members_name
Not documented.
vdhcp6_arch
The DHCPv6 architecture type, either single for Single-Server, splitscope for Split-Scope or
stateless for Stateless.
vdhcp6_parent_name
Not documented.
vdhcp6_parent_arch
Not documented.
vdhcp6_parent_id
Not documented.
vdhcp6_ref1_dhcp6_name
Not documented.
vdhcp6_ref1_dhcp6_id
Not documented.
vdhcp6_ref2_dhcp6_name
Not documented.
vdhcp6_ref2_dhcp6_id
Not documented.
dhcp6_uboottime
Time at which the DHCPv6 service started for the last time, in UTC format.
dhcp6_id
Not documented.
dhcp6_type
Not documented.
site_name
site name.

281
 DHCPv6 Server

dhcp6_state
Not documented.
dhcp6_synching
Not documented.
dhcp6_name
Not documented.
dhcp6_comment
Not documented.
dhcp6_version
Not documented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_parameters
The dhcp6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dhcp6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).
ip6_addr
IP6 address.

282
 DHCPv6 Server

Name
dhcp6_server6_info — Display the properties of a DHCPv6 server
Description
The service dhcp6_server6_info returns all the information available regarding the DHCPv6
server specified in input.

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
ipmdhcp6_https_login
Not documented.
ipmdhcp6_https_password
Not documented.
isolated
If the server is isolated, it does not apply the configured default behaviors.
vdhcp6_param1
Not documented.
ref1_dhcp6_name
Not documented.
vdhcp6_ref1_dhcp6_id
Not documented.
ref2_dhcp6_name
Not documented.
vdhcp6_ref2_dhcp6_id
Not documented.
tree_level
Depth of imbricated spaces.
total_vdhcp6_members
Not documented.
vdhcp6_members_name
Not documented.
vdhcp6_arch
The DHCPv6 architecture type, either single for Single-Server, splitscope for Split-Scope or
stateless for Stateless.
vdhcp6_parent_name
Not documented.

283
 DHCPv6 Server

vdhcp6_parent_arch
Not documented.
vdhcp6_parent_id
Not documented.
vdhcp6_ref1_dhcp6_name
Not documented.
vdhcp6_ref1_dhcp6_id
Not documented.
vdhcp6_ref2_dhcp6_name
Not documented.
vdhcp6_ref2_dhcp6_id
Not documented.
dhcp6_uboottime
Time at which the DHCPv6 service started for the last time, in UTC format.
dhcp6_id
Not documented.
dhcp6_type
Not documented.
site_name
Name of the IPAM space associated with the server.
dhcp6_state
DHCPv6 server status.
dhcp6_synching
Server synchronization status.
dhcp6_name
DHCPv6 server name.
dhcp6_comment
DHCPv6 server description.
dhcp6_version
DHCPv6 server version.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_parameters
The dhcp6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp6_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dhcp6_class_parameters parameter the URL value must be encoded in
URL format (see RFC 3986).

284
 DHCPv6 Server

ip6_addr
IP6 address.

285
 DHCPv6 Server

Name
dhcp46_server46_count — Number of DHCPv4 and DHCPv6 servers in the database
Description
The service dhcp46_server46_count returns the number of DHCPv4 and DHCPv6 servers in the
database. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp46_id, dhcp_id, type, ipmdhcp_protocol, ipmdh-
cp_https_login, ipmdhcp_https_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1,
tcp_port, ms_use_ssl, windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry,
snmp_timeout, snmp_use_tcp, cisco_use_ssh, cisco_login, cisco_password,
cisco_root_password, ref1_dhcp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdh-
cp_ref2_dhcp_id, tree_level, total_vdhcp_members, vdhcp_members_name, vdhcp_arch,
vdhcp_parent_name, vdhcp_parent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdh-
cp_ref1_dhcp_id, vdhcp_ref2_dhcp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id,
dhcp_type, site_name, dhcp_state, dhcp_synching, dhcp_name, dhcp_comment, dhcp_ver-
sion, row_enabled, dhcp_custom1, dhcp_custom2, dhcp_custom3, dhcp_class_name, dh-
cp_class_parameters, ip_addr.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp46_id, dhcp_id, type, ipmdhcp_protocol, ipmdh-
cp_https_login, ipmdhcp_https_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1,
tcp_port, ms_use_ssl, windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry,
snmp_timeout, snmp_use_tcp, cisco_use_ssh, cisco_login, cisco_password,
cisco_root_password, ref1_dhcp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdh-
cp_ref2_dhcp_id, tree_level, total_vdhcp_members, vdhcp_members_name, vdhcp_arch,
vdhcp_parent_name, vdhcp_parent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdh-
cp_ref1_dhcp_id, vdhcp_ref2_dhcp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id,
dhcp_type, site_name, dhcp_state, dhcp_synching, dhcp_name, dhcp_comment, dhcp_ver-
sion, row_enabled, dhcp_custom1, dhcp_custom2, dhcp_custom3, dhcp_class_name, dh-
cp_class_parameters, ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

286
 DHCPv6 Server

Name
dhcp46_server46_list — List the DHCPv4 and DHCPv6 servers in the database
Description
The service dhcp46_server46_list allows to list the DHCPv4 and DHCPv6 servers in the database.
The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp46_id, dhcp_id, type, ipmdhcp_protocol, ipmdh-
cp_https_login, ipmdhcp_https_password, isolated, dhcp_dcs_key, tree_path, vdhcp_param1,
tcp_port, ms_use_ssl, windhcp_protocol, snmp_id, snmp_port, snmp_profile_id, snmp_retry,
snmp_timeout, snmp_use_tcp, cisco_use_ssh, cisco_login, cisco_password,
cisco_root_password, ref1_dhcp_name, vdhcp_ref1_dhcp_id, ref2_dhcp_name, vdh-
cp_ref2_dhcp_id, tree_level, total_vdhcp_members, vdhcp_members_name, vdhcp_arch,
vdhcp_parent_name, vdhcp_parent_arch, vdhcp_parent_id, vdhcp_ref1_dhcp_name, vdh-
cp_ref1_dhcp_id, vdhcp_ref2_dhcp_name, vdhcp_ref2_dhcp_id, dhcp_uboottime, dhcp_id,
dhcp_type, site_name, dhcp_state, dhcp_synching, dhcp_name, dhcp_comment, dhcp_ver-
sion, row_enabled, dhcp_custom1, dhcp_custom2, dhcp_custom3, dhcp_class_name, dh-
cp_class_parameters, ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

287
 DHCPv6 Server

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp46_id
The DHCP server unique identifier (ID) within the DHCPv4/DHCPv6 database.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
ipmdhcp_protocol
IPM DHCP protocol.
ipmdhcp_https_login
IPM DHCP https login.
ipmdhcp_https_password
IPM DHCP https password.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
dhcp_dcs_key
DHCP DCS CC key (dcs).
vdhcp_param1
VDHCP param1 (VDHCP).
tcp_port
Not documented.
ms_use_ssl
Windhcp use SSL (windhcp).
windhcp_protocol
Not documented.
snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
snmp_port
SNMP port.
snmp_profile_id
The snmp_profile_id parameter is the SNMP profile identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
snmp_retry
SNMP retry (ipm).
snmp_timeout
Timeout (seconds).
snmp_use_tcp
Use TCP transport.
cisco_use_ssh
DHCP Cisco use SSH.

288
 DHCPv6 Server

cisco_login
DHCP Cisco login (cisco).
cisco_password
DHCP Cisco password (cisco).
cisco_root_password
DHCP Cisco root password (cisco).
ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
tree_level
Depth of imbricated spaces.
total_vdhcp_members
Not documented.
vdhcp_members_name
Not documented.
vdhcp_arch
VDHCP architecture (VDHCP).
vdhcp_parent_name
Not documented.
vdhcp_parent_arch
Not documented.
vdhcp_parent_id
Not documented.
vdhcp_ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
vdhcp_ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
dhcp_uboottime
Time at which the DHCP service started for the last time, in UTC format.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
site_name
site name.

289
 DHCPv6 Server

dhcp_state
Not documented.
dhcp_synching
Not documented.
dhcp_name
DHCP server name.
dhcp_comment
Not documented.
dhcp_version
Not documented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_parameters
The dhcp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dhcp_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
ip_addr
IP address.

290
 DHCPv6 Server

Name
dhcp46_server46_info — Display the properties of a DHCPv4 or DHCPv6 server
Description
The service dhcp46_server46_info allows to display the properties of the DHCP server specified,
whether DHCPv4 or DHCPv6. For this service, the dhcp_id input parameter accepts the identifier
of a DHCPv4 or a DHCPv6 server.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
dhcp_id
The DHCP server identifier (ID). For the service dhcp46_server46_info, the dhcp_id accepts
the identifier of any DHCP server, whether a DHCPv4 or a DHCPv6 server. This identifier is
a unique numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp46_id
The DHCP server unique identifier (ID) within the DHCPv4/DHCPv6 database.
dhcp_id
The DHCP server identifier (ID). For the service dhcp46_server46_info, the dhcp_id returns
the identifier of any DHCP server, whether a DHCPv4 or a DHCPv6 server. This identifier is
a unique numeric key value that is automatically incremented.
ipmdhcp_protocol
IPM DHCP protocol.
ipmdhcp_https_login
IPM DHCP https login.
ipmdhcp_https_password
IPM DHCP https password.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
dhcp_dcs_key
DHCP DCS CC key (dcs).
vdhcp_param1
VDHCP param1 (VDHCP).
tcp_port
Not documented.
ms_use_ssl
Windhcp use SSL (windhcp).
windhcp_protocol
Not documented.

291
 DHCPv6 Server

snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
snmp_port
SNMP port.
snmp_profile_id
The snmp_profile_id parameter is the SNMP profile identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
snmp_retry
SNMP retry (ipm).
snmp_timeout
Timeout (seconds).
snmp_use_tcp
Use TCP transport.
cisco_use_ssh
DHCP Cisco use SSH.
cisco_login
DHCP Cisco login (cisco).
cisco_password
DHCP Cisco password (cisco).
cisco_root_password
DHCP Cisco root password (cisco).
ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
tree_level
Depth of imbricated spaces.
total_vdhcp_members
Not documented.
vdhcp_members_name
Not documented.
vdhcp_arch
VDHCP architecture (VDHCP).
vdhcp_parent_name
Not documented.
vdhcp_parent_arch
Not documented.
vdhcp_parent_id
Not documented.

292
 DHCPv6 Server

vdhcp_ref1_dhcp_name
Not documented.
vdhcp_ref1_dhcp_id
VDHCP ref1 DHCP ID (VDHCP).
vdhcp_ref2_dhcp_name
Not documented.
vdhcp_ref2_dhcp_id
VDHCP ref2 DHCP ID (VDHCP).
dhcp_uboottime
Time at which the DHCP service started for the last time, in UTC format.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
site_name
site name.
dhcp_state
Not documented.
dhcp_synching
Not documented.
dhcp_name
DHCP server name.
dhcp_comment
Not documented.
dhcp_version
Not documented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_parameters
The dhcp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dhcp_class_parameters parameter the URL value must be encoded in URL
format (see RFC 3986).
ip_addr
IP address.

293
 DHCPv6 Server

Name
dhcp6_server6_options6_list — List the DHCP options set on a DHCPv6 server
Description
The service dhcp6_server6_options6_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
dhcp6_id
The DHCPv6 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

294
 DHCPv6 Server

Name
dhcp6_server6_admin_group_count — Total number of groups that can access
the DHCPv6 server list

Description
The service dhcp6_server6_admin_group_count allows to display the total number of groups of
users that can access the DHCPv6 server list. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcp6_id
The DHCPv6 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

295
 DHCPv6 Server

Name
dhcp6_server6_admin_group_list — List all the groups that can access the
DHCPv6 server list

Description
The service dhcp6_server6_admin_group_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcp6_id
The DHCPv6 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.

296
 DHCPv6 Server

grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

297
 DHCPv6 Server

Name
dhcp6_server6_admin_service_count — Total number of rights for a group
to add/delete objects in a DHCPv6 server

Description
The service dhcp6_server6_admin_service_count allows to display the total number of rights for
a group of users to add/delete objects in a DHCPv6 server. The rows returned to the user running
the service are not subject to the group resources, this service returns data as if the user running
it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

298
 DHCPv6 Server

Name
dhcp6_server6_admin_service_list — List all the rights of a group to add/delete
objects in a DHCPv6 server

Description
The service dhcp6_server6_admin_service_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

299
 DHCPv6 Server

Name
group_dhcp6_add — Add a DHCPv6 server as group resource
Description
The service group_dhcp6_add allows to add an object as resource for a group of users. You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcp6_id
The DHCPv6 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

300
 DHCPv6 Server

Name
group_dhcp6_delete — Remove a DHCPv6 server from a group resources
Description
The service group_dhcp6_delete allows to delete SOLIDserver database object. The service
group_dhcp6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcp6_id
The DHCPv6 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

301
 DHCPv6 Server

Name
dhcp6_delete — Delete a DHCPv6 server
Description
The service dhcp6_delete allows to delete SOLIDserver database object.The service dhcp6_delete
needs to identify the object to delete with the input parameters detailed in the next section. This
service will be executed if the connected user running this service is allowed to delete the con-
cerned object

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

302
Chapter 23. DHCPv4 Group

303
 DHCPv4 Group

Name
dhcp_group_add — Add/Edit a DHCPv4 group
Description
The service dhcp_group_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
ip_id
The DHCP server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
dhcp_ip_id
The dhcp_ip_id parameter is the DHCP server address identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpgroup_name
DHCP group name.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpgroup_class_name
The dhcpgroup_class_name is the name of the file class that will used for this object. The
name of dhcpgroup_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
group_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpgroup_class_parameters
The dhcpgroup_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpgroup_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpgroup_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).

304
 DHCPv4 Group

keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

305
 DHCPv4 Group

Name
dhcp_group_count — Number of DHCPv4 groups
Description
The service dhcp_group_count allows to display the number of DHCPv4 groups.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpgroup_id, dhcp_id, dhcp_name, dhcp_type, vdh-
cp_parent_id, dhcpgroup_name, delayed_create_time, delayed_delete_time, vdhcp_par-
ent_name, dhcp_class_name, dhcp_version, ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

306
 DHCPv4 Group

Name
dhcp_group_list — List the DHCPv4 groups
Description
The service dhcp_group_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpgroup_id, dhcp_id, dhcp_name, dhcp_type, vdh-
cp_parent_id, dhcpgroup_name, delayed_create_time, delayed_delete_time, vdhcp_par-
ent_name, dhcp_class_name, dhcp_version, ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.

307
 DHCPv4 Group

dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpgroup_name
DHCP group name.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
vdhcp_parent_name
Not documented.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_version
Not documented.
ip_addr
IP address.

308
 DHCPv4 Group

Name
dhcp_group_info — Display the properties of a DHCPv4 group
Description
The service dhcp_group_info returns the information on the object specified in input.

Input Parameters
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpgroup_name
DHCP group name.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
vdhcp_parent_name
Not documented.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_version
Not documented.
ip_addr
IP address.

309
 DHCPv4 Group

Name
dhcp_group_options_list — List the DHCP options set on a DHCPv4 group
Description
The service dhcp_group_options_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

310
 DHCPv4 Group

Name
dhcp_group_delete — Delete a DHCPv4 group
Description
The service dhcp_group_delete allows to delete SOLIDserver database object.The dhcp_group_de-
lete service needs to identify the object to delete with the input parameters detailed in the next
section. This service will be executed if the connected user running this service is allowed to
delete the concerned object

Input Parameters
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
group_id
The group_id parameter is the DHCP group identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpgroup_name
DHCP group name.
group_name
DHCP group name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

311
Chapter 24. DHCPv6 Group

312
 DHCPv6 Group

Name
dhcp6_group6_add — Add/Edit a DHCPv6 group
Description
The service dhcp6_group6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
ip6_id
The ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp6_ip6_id
The dhcp6_ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpgroup6_name
DHCPv6 group name.
dhcpgroup6_id
The dhcpgroup6_id parameter is the DHCPv6 group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpgroup6_class_name
The dhcpgroup6_class_name is the name of the file class that will used for this object. The
name of dhcpgroup6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpgroup6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpgroup6_class_parameters
The dhcpgroup6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpgroup6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpgroup6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).

313
 DHCPv6 Group

keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

314
 DHCPv6 Group

Name
dhcp6_group6_count — Number of DHCPv6 groups
Description
The service dhcp6_group6_count allows to display the number of DHCPv6 groups.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpgroup6_id, dhcp6_id, dhcp6_name, dhcp6_type,

vdhcp6_parent_id, dhcpgroup6_name, delayed_time, vdhcp6_parent_name, dh-
cp6_class_name, dhcp6_version, ip6_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

315
 DHCPv6 Group

Name
dhcp6_group6_list — List the DHCPv6 groups
Description
The service dhcp6_group6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpgroup6_id, dhcp6_id, dhcp6_name, dhcp6_type,

vdhcp6_parent_id, dhcpgroup6_name, delayed_time, vdhcp6_parent_name, dh-
cp6_class_name, dhcp6_version, ip6_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpgroup6_id
Not documented.
dhcp6_id
Not documented.
dhcp6_name
Not documented.

316
 DHCPv6 Group

dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.
dhcpgroup6_name
Not documented.
delayed_time
Not documented.
vdhcp6_parent_name
Not documented.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.
ip6_addr
IP6 address.

317
 DHCPv6 Group

Name
dhcp6_group6_info — Display the properties of a DHCPv6 group
Description
The service dhcp6_group6_info returns the information on the object specified in input.

Input Parameters
dhcpgroup6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpgroup6_id
Not documented.
dhcp6_id
Not documented.
dhcp6_name
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.
dhcpgroup6_name
Not documented.
delayed_time
Not documented.
vdhcp6_parent_name
Not documented.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.
ip6_addr
IP6 address.

318
 DHCPv6 Group

Name
dhcp6_group6_options6_list — List the DHCP options set on a DHCPv6 group
Description
The service dhcp6_group6_options6_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
dhcpgroup6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

319
 DHCPv6 Group

Name
dhcp6_group6_delete — Delete a DHCPv6 group
Description
The service dhcp6_group6_delete allows to delete SOLIDserver database object. The service
dhcp6_group6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

320
Chapter 25. DHCPv4 Scope

321
 DHCPv4 Scope

Name
dhcp_scope_add — Add/Edit a DHCPv4 scope
Description
The service dhcp_scope_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
netaddr
DHCP scope address.
dhcpscope_net_addr
DHCP scope address.
dhcpscope_start_addr
DHCP scope address.
dhcpscope_netaddr
DHCP scope address.
netmask
DHCP scope netmask.
dhcpscope_net_mask
DHCP scope netmask.
dhcpscope_netmask
DHCP scope netmask.
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn_name
Shared network name.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

322
 DHCPv4 Scope

dhcpscope_name
DHCP scope name.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP failover identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpfailover_name
DHCP failover name.
dhcpscope_site_id
The dhcpscope_site_id parameter is the DHCP Scope space identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpscope_site_name
DHCP scope space name.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope_class_parameters
The dhcpscope_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpscope_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

323
 DHCPv4 Scope

Name
dhcp_scope_count — Numbers of DHCPv4 scopes
Description
The service dhcp_scope_count allows to display the number of DHCPv4 scopes.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp_parent_id, vdhcp_arch, dhcp_type, dhcpfail-

over_id, dhcpfailover_name, dhcpscope_id, dhcp_id, dhcp_name, dhcpscope_name, dhcp-
scope_start_ip_addr, dhcpscope_end_ip_addr, dhcpscope_net_addr, dhcpscope_net_mask,
dhcpscope_size, delayed_create_time, delayed_delete_time, dhcpscope_site_name, dhcp-
scope_site_id, dhcpscope_sort_name, dhcpscope_custom1, dhcpscope_custom2, dhcp-
scope_custom3, dhcpscope_class_name, dhcpscope_class_parameters, dhcpsn_id, dh-
cpsn_name, vdhcp_parent_name, dhcp_class_name, dhcp_version.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

324
 DHCPv4 Scope

Name
dhcp_scope_list — List the DHCPv4 scopes
Description
The service dhcp_scope_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp_parent_id, vdhcp_arch, dhcp_type, dhcpfail-

over_id, dhcpfailover_name, dhcpscope_id, dhcp_id, dhcp_name, dhcpscope_name, dhcp-
scope_start_ip_addr, dhcpscope_end_ip_addr, dhcpscope_net_addr, dhcpscope_net_mask,
dhcpscope_size, delayed_create_time, delayed_delete_time, dhcpscope_site_name, dhcp-
scope_site_id, dhcpscope_sort_name, dhcpscope_custom1, dhcpscope_custom2, dhcp-
scope_custom3, dhcpscope_class_name, dhcpscope_class_parameters, dhcpsn_id, dh-
cpsn_name, vdhcp_parent_name, dhcp_class_name, dhcp_version.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp_parent_id
Not documented.

325
 DHCPv4 Scope

vdhcp_arch
VDHCP architecture (VDHCP).
dhcp_type
DHCP server type.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpfailover_name
DHCP group name.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
dhcpscope_name
DHCP scope name.
dhcpscope_start_ip_addr
Not documented.
dhcpscope_end_ip_addr
Not documented.
dhcpscope_net_addr
DHCP scope address.
dhcpscope_net_mask
DHCP scope netmask.
dhcpscope_size
Not documented.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dhcpscope_site_name
DHCP scope space name.
dhcpscope_site_id
The dhcpscope_site_id parameter is the DHCP Scope space identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope_class_parameters
The dhcpscope_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global

326
 DHCPv4 Scope

customized fields as well. The dhcpscope_class_parameters parameter accepts several

meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn_name
Shared network name.
vdhcp_parent_name
Not documented.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_version
Not documented.

327
 DHCPv4 Scope

Name
dhcp_scope_info — Display the properties of a DHCPv4 scope
Description
The service dhcp_scope_info returns the information on the object specified in input.

Input Parameters
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp_parent_id
Not documented.
vdhcp_arch
VDHCP architecture (VDHCP).
dhcp_type
DHCP server type.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpfailover_name
DHCP group name.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
dhcpscope_name
DHCP scope name.
dhcpscope_start_ip_addr
Not documented.
dhcpscope_end_ip_addr
Not documented.
dhcpscope_net_addr
DHCP scope address.
dhcpscope_net_mask
DHCP scope netmask.

328
 DHCPv4 Scope

dhcpscope_size
Not documented.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dhcpscope_site_name
DHCP scope space name.
dhcpscope_site_id
The dhcpscope_site_id parameter is the DHCP Scope space identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope_class_parameters
The dhcpscope_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpscope_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn_name
Shared network name.
vdhcp_parent_name
Not documented.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_version
Not documented.

329
 DHCPv4 Scope

Name
dhcp_scope_options_list — List the DHCP options set on a DHCPv4 scope
Description
The service dhcp_scope_options_list allows to list entries from SOLIDserver database.To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

330
 DHCPv4 Scope

Name
dhcp_scope_admin_group_count — Total number of groups that can access
the DHCPv4 scope list

Description
The service dhcp_scope_admin_group_count allows to display the total number of groups of
users that can access the DHCPv4 scope list. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

331
 DHCPv4 Scope

Name
dhcp_scope_admin_group_list — List all the groups that can access the DHCPv4
scope list

Description
The service dhcp_scope_admin_group_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

332
 DHCPv4 Scope

grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

333
 DHCPv4 Scope

Name
dhcp_scope_admin_service_count — Total number of rights for a group to
add/delete objects in a DHCPv4 scope

Description
The service dhcp_scope_admin_service_count allows to display the total number of rights for a
group of users to add/delete objects in a DHCPv4 scope. The rows returned to the user running
the service are not subject to the group resources, this service returns data as if the user running
it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

334
 DHCPv4 Scope

Name
dhcp_scope_admin_service_list — List all the rights of a group to add/delete
objects in a DHCPv4 scope

Description
The service dhcp_scope_admin_service_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

335
 DHCPv4 Scope

Name
group_dhcpscope_add — Add a DHCPv4 scope as group resource
Description
The service group_dhcpscope_add allows to add an object as resource for a group of users.You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcpscope_id
The DHCPv4 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

336
 DHCPv4 Scope

Name
group_dhcpscope_delete — Remove a DHCPv4 scope from a group resources
Description
The service group_dhcpscope_delete allows to delete SOLIDserver database object. The service
group_dhcpscope_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcpscope_id
The DHCPv4 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

337
 DHCPv4 Scope

Name
dhcp_scope_delete — Delete a DHCPv4 scope
Description
The service dhcp_scope_delete allows to delete SOLIDserver database object. The dh-
cp_scope_delete service needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpscope_id
The dhcpscope_id parameter is the DHCP Scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
scope_id
The scope_id parameter is the DHCP Scope identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpscope_name
DHCP scope name.
scope_name
DHCP scope name.
netaddr
DHCP scope address.
dhcpscope_net_addr
DHCP scope address.
dhcpscope_start_addr
DHCP scope address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

338
Chapter 26. DHCPv6 Scope

339
 DHCPv6 Scope

Name
dhcp6_scope6_add — Add/Edit a DHCPv6 scope
Description
The service dhcp6_scope6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
dhcpscope6_start_addr
DHCPv6 scope address.
dhcpscope6_end_addr
DHCPv6 scope address.
dhcpscope6_prefix
DHCPv6 prefix.
dhcpsn6_id
The dhcpsn6_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn6_name
Shared network name.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcpscope6_name
DHCPv6 scope name.
dhcpfailover6_id
The dhcpfailover6_id parameter is the DHCPv6 failover identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpfailover6_name
DHCPv6 failover name.

340
 DHCPv6 Scope

dhcpscope6_site_id
The dhcpscope6_site_id parameter is the DHCPv6 Scope space identifier (ID).This identifier
is a unique numeric key value that is automatically incremented.
dhcpscope6_site_name
DHCPv6 scope space name.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope6_class_parameters
The dhcpscope6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpscope6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

341
 DHCPv6 Scope

Name
dhcp6_scope6_count — Number of DHCPv6 scopes
Description
The service dhcp6_scope6_count allows to display the number of DHCPv6 scopes.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp6_parent_id, vdhcp6_arch, dhcp6_type, dhcpfail-

over6_id, dhcpfailover6_name, dhcpscope6_id, dhcp6_id, dhcp6_name, dhcpscope6_name,
dhcpscope6_start_ip6_addr, dhcpscope6_end_ip6_addr, dhcpscope6_size, dhcpscope6_pre-
fix, delayed_time, dhcpscope6_site_name, dhcpscope6_site_id, dhcpscope6_sort_name,
dhcpscope6_class_name, dhcpscope6_class_parameters, dhcpsn6_id, dhcpsn6_name,
vdhcp6_parent_name, dhcp6_class_name, dhcp6_version.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

342
 DHCPv6 Scope

Name
dhcp6_scope6_list — List the DHCPv6 scopes
Description
The service dhcp6_scope6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use the service dhcp6_scope6_list. The rows re-
turned to the user running the service depend on the resources granted to the group they belong
to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp6_parent_id, vdhcp6_arch, dhcp6_type, dhcpfail-

over6_id, dhcpfailover6_name, dhcpscope6_id, dhcp6_id, dhcp6_name, dhcpscope6_name,
dhcpscope6_start_ip6_addr, dhcpscope6_end_ip6_addr, dhcpscope6_size, dhcpscope6_pre-
fix, delayed_time, dhcpscope6_site_name, dhcpscope6_site_id, dhcpscope6_sort_name,
dhcpscope6_class_name, dhcpscope6_class_parameters, dhcpsn6_id, dhcpsn6_name,
vdhcp6_parent_name, dhcp6_class_name, dhcp6_version.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp6_parent_id
Not documented.

343
 DHCPv6 Scope

vdhcp6_arch
The DHCPv6 architecture type, either single for Single-Server, splitscope for Split-Scope or
stateless for Stateless.
dhcp6_type
Not documented.
dhcpfailover6_id
Not documented.
dhcpfailover6_name
Not documented.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp6_id
Not documented.
dhcp6_name
Not documented.
dhcpscope6_name
Not documented.
dhcpscope6_start_ip6_addr
Not documented.
dhcpscope6_end_ip6_addr
Not documented.
dhcpscope6_size
Not documented.
dhcpscope6_prefix
Not documented.
delayed_time
Not documented.
dhcpscope6_site_name
Not documented.
dhcpscope6_site_id
Not documented.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope6_class_parameters
The dhcpscope6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpscope6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcpsn6_id
Not documented.

344
 DHCPv6 Scope

dhcpsn6_name
Not documented.
vdhcp6_parent_name
Not documented.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.

345
 DHCPv6 Scope

Name
dhcp6_scope6_info — Display the properties of a DHCPv6 scope
Description
The service dhcp6_scope6_info returns the information on the object specified in input.

Input Parameters
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp6_parent_id
Not documented.
vdhcp6_arch
The DHCPv6 architecture type, either single for Single-Server, splitscope for Split-Scope or
stateless for Stateless.
dhcp6_type
Not documented.
dhcpfailover6_id
Not documented.
dhcpfailover6_name
Not documented.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp6_id
Not documented.
dhcp6_name
Not documented.
dhcpscope6_name
Not documented.
dhcpscope6_start_ip6_addr
Not documented.
dhcpscope6_end_ip6_addr
Not documented.
dhcpscope6_size
Not documented.
dhcpscope6_prefix
Not documented.

346
 DHCPv6 Scope

delayed_time
Not documented.
dhcpscope6_site_name
Not documented.
dhcpscope6_site_id
Not documented.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope6_class_parameters
The dhcpscope6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpscope6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcpsn6_id
Not documented.
dhcpsn6_name
Not documented.
vdhcp6_parent_name
Not documented.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.

347
 DHCPv6 Scope

Name
dhcp6_scope6_options6_list — List the DHCP options set on a DHCPv6 scope
Description
The service dhcp6_scope6_options6_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

348
 DHCPv6 Scope

Name
dhcp6_scope6_admin_group_count — Total number of groups that can access
the DHCPv6 scope list

Description
The service dhcp6_scope6_admin_group_count allows to display the total number of groups of
users that can access the DHCPv6 scope list. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

349
 DHCPv6 Scope

Name
dhcp6_scope6_admin_group_list — List all the groups that can access the
DHCPv6 scope list

Description
The service dhcp6_scope6_admin_group_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.

350
 DHCPv6 Scope

grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

351
 DHCPv6 Scope

Name
dhcp6_scope6_admin_service_count — Total number of rights for a group to
add/delete objects in a DHCPv6 scope

Description
The service dhcp6_scope6_admin_service_count allows to display the total number of rights for
a group of users to add/delete objects in a DHCPv6 scope. The rows returned to the user running
the service are not subject to the group resources, this service returns data as if the user running
it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

352
 DHCPv6 Scope

Name
dhcp6_scope6_admin_service_list — List all the rights of a group to add/delete
objects in a DHCPv6 scope

Description
The service dhcp6_scope6_admin_service_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The grp_id parameter is the Group identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

353
 DHCPv6 Scope

Name
group_dhcpscope6_add — Add a DHCPv6 scope as group resource
Description
The service group_dhcpscope6_add allows to add an object as resource for a group of users.
You must specify the group of users and the object that you set as resource. Once set as a re-
source, the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use the service group_dhcp-
scope6_add.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

354
 DHCPv6 Scope

Name
group_dhcpscope6_delete — Remove s DHCPv6 scope from a group resources
Description
The service group_dhcpscope6_delete allows to delete SOLIDserver database object.The service
group_dhcpscope6_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

355
 DHCPv6 Scope

Name
dhcp6_scope6_delete — Delete a DHCPv6 scope
Description
The service dhcp6_scope6_delete allows to delete SOLIDserver database object. The service
dhcp6_scope6_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
scope6_id
The scope6_id parameter is the DHCPv6 Scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpscope6_name
DHCPv6 scope name.
scope6_name
DHCPv6 scope name.
dhcpscope6_start_addr
DHCPv6 scope address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

356
Chapter 27. DHCPv4 Shared Network

357
 DHCPv4 Shared Network

Name
dhcp_sn_add — Add/Edit a DHCPv4 shared network
Description
The service dhcp_sn_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
ip_id
The DHCP server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
dhcp_ip_id
The dhcp_ip_id parameter is the DHCP server address identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpsn_id
The dhcpsn_id parameter is the DHCP shared network identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpsn_name
DHCP shared network name.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

358
 DHCPv4 Shared Network

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

359
 DHCPv4 Shared Network

Name
dhcp_shared_network_count — Number of DHCPv4 shared networks
Description
The service dhcp_shared_network_count allows to display the number of DHCPv4 shared net-
works.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpsn_id, dhcpsn_name, dhcp_id, dhcp_name, dh-
cp_type, vdhcp_parent_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

360
 DHCPv4 Shared Network

Name
dhcp_shared_network_list — List the DHCPv4 shared networks
Description
The service dhcp_shared_network_list allows to list entries from SOLIDserver database. To ex-
ecute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpsn_id, dhcpsn_name, dhcp_id, dhcp_name, dh-
cp_type, vdhcp_parent_id.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn_name
Shared network name.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

361
 DHCPv4 Shared Network

dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.

362
 DHCPv4 Shared Network

Name
dhcp_shared_network_info — Display the properties of a DHCPv4 shared network
Description
The service dhcp_shared_network_info returns the information on the object specified in input.

Input Parameters
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn_name
Shared network name.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.

363
Chapter 28. DHCPv6 Shared Network

364
 DHCPv6 Shared Network

Name
dhcp6_sn6_add — Add/Edit a DHCPv6 shared network
Description
The service dhcp6_sn6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
ip6_id
The ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp6_ip6_id
The dhcp6_ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpsn6_id
The dhcpsn6_id parameter is the DHCPv6 shared network identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpsn6_name
DHCPv6 shared network name.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

365
 DHCPv6 Shared Network

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

366
 DHCPv6 Shared Network

Name
dhcp6_shared_network6_count — Number of DHCPv6 shared networks
Description
The service dhcp6_shared_network6_count allows to display the number of DHCPv6 shared
networks.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpsn6_id, dhcpsn6_name, dhcp6_id, dhcp6_name,

dhcp6_type, vdhcp6_parent_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

367
 DHCPv6 Shared Network

Name
dhcp6_shared_network6_list — List the DHCPv6 shared networks
Description
The service dhcp6_shared_network6_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpsn6_id, dhcpsn6_name, dhcp6_id, dhcp6_name,

dhcp6_type, vdhcp6_parent_id.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpsn6_id
Not documented.
dhcpsn6_name
Not documented.
dhcp6_id
Not documented.

368
 DHCPv6 Shared Network

dhcp6_name
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.

369
 DHCPv6 Shared Network

Name
dhcp6_shared_network6_info — Display the properties of a DHCPv6 shared
network

Description
The service dhcp6_shared_network6_info return the information on the object specified in input.

Input Parameters
dhcpsn6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpsn6_id
Not documented.
dhcpsn6_name
Not documented.
dhcp6_id
Not documented.
dhcp6_name
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.

370
Chapter 29. DHCPv4 Range

371
 DHCPv4 Range

Name
dhcp_range_add — Add/Edit a DHCPv4 range
Description
The service dhcp_range_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpscope_name
DHCP scope name.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
scope_id
The scope_id parameter is the DHCP scope identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
start_addr
DHCP range start address.
dhcprange_start_addr
DHCP range start address.
end_addr
DHCP range end address.
dhcprange_end_addr
DHCP range end address.
failover_name
DHCP failover name.
dhcprange_failover_name
DHCP failover name.

372
 DHCPv4 Range

acl
DHCP range acl.
dhcprange_name
DHCP range name.
dhcprange_acl
DHCP range acl.
dhcprange_class_name
The dhcprange_class_name is the name of the file class that will used for this object. The
name of dhcprange_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
prange_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope_class_parameters
The dhcpscope_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpscope_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

373
 DHCPv4 Range

Name
dhcp_range_count — Number of DHCPv4 ranges
Description
The service dhcp_range_count allows to display the number of DHCPv4 ranges.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcprange_id, delayed_create_time, delayed_de-

lete_time, dhcpscope_id, dhcprange_name, dhcprange_start_addr, dhcprange_end_addr,
dhcprange_start_ip_addr, dhcprange_end_ip_addr, dhcp_id, dhcp_type, dhcp_name, vdh-
cp_parent_id, dhcpscope_name, dhcpscope_if_name, dhcpscope_if_addr, dhcpscope_net_ad-
dr, dhcpscope_net_mask, dhcpscope_start_ip_addr, dhcpscope_size, dhcprange_fail-
over_name, dhcprange_state, dhcprange_custom1, dhcprange_custom2, dhcprange_custom3,
dhcprange_class_name, dhcprange_class_parameters, dhcprange_lease_count, dhc-
prange_size, dhcprange_lease_percent, dhcprange_acl, dhcpsn_id, dhcpsn_name, vdh-
cp_parent_name, dhcp_comment, dhcpscope_class_name, dhcp_class_name, dhcp_version.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

374
 DHCPv4 Range

Name
dhcp_range_list — List the DHCPv4 ranges
Description
The service dhcp_range_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcprange_id, delayed_create_time, delayed_de-

lete_time, dhcpscope_id, dhcprange_name, dhcprange_start_addr, dhcprange_end_addr,
dhcprange_start_ip_addr, dhcprange_end_ip_addr, dhcp_id, dhcp_type, dhcp_name, vdh-
cp_parent_id, dhcpscope_name, dhcpscope_if_name, dhcpscope_if_addr, dhcpscope_net_ad-
dr, dhcpscope_net_mask, dhcpscope_start_ip_addr, dhcpscope_size, dhcprange_fail-
over_name, dhcprange_state, dhcprange_custom1, dhcprange_custom2, dhcprange_custom3,
dhcprange_class_name, dhcprange_class_parameters, dhcprange_lease_count, dhc-
prange_size, dhcprange_lease_percent, dhcprange_acl, dhcpsn_id, dhcpsn_name, vdh-
cp_parent_name, dhcp_comment, dhcpscope_class_name, dhcp_class_name, dhcp_version.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

375
 DHCPv4 Range

dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcprange_name
DHCP range name.
dhcprange_start_addr
DHCP range start address.
dhcprange_end_addr
DHCP range end address.
dhcprange_start_ip_addr
Not documented.
dhcprange_end_ip_addr
Not documented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
dhcp_name
DHCP server name.
vdhcp_parent_id
Not documented.
dhcpscope_name
DHCP scope name.
dhcpscope_if_name
Not documented.
dhcpscope_if_addr
Not documented.
dhcpscope_net_addr
DHCP scope address.
dhcpscope_net_mask
DHCP scope netmask.
dhcpscope_start_ip_addr
Not documented.
dhcpscope_size
Not documented.
dhcprange_failover_name
DHCP failover name.

376
 DHCPv4 Range

dhcprange_state
Not documented.
dhcprange_class_name
The dhcprange_class_name is the name of the file class that will used for this object. The
name of dhcprange_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
prange_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcprange_class_parameters
The dhcprange_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcprange_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcprange_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcprange_lease_count
Not documented.
dhcprange_size
Not documented.
dhcprange_lease_percent
Not documented.
dhcprange_acl
DHCP range acl.
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn_name
Shared network name.
vdhcp_parent_name
Not documented.
dhcp_comment
Not documented.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_version
Not documented.

377
 DHCPv4 Range

Name
dhcp_range_info — Display the properties of a DHCPv4 range
Description
The service dhcp_range_info returns the information on the object specified in input.

Input Parameters
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcprange_name
DHCP range name.
dhcprange_start_addr
DHCP range start address.
dhcprange_end_addr
DHCP range end address.
dhcprange_start_ip_addr
Not documented.
dhcprange_end_ip_addr
Not documented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
dhcp_name
DHCP server name.
vdhcp_parent_id
Not documented.

378
 DHCPv4 Range

dhcpscope_name
DHCP scope name.
dhcpscope_if_name
Not documented.
dhcpscope_if_addr
Not documented.
dhcpscope_net_addr
DHCP scope address.
dhcpscope_net_mask
DHCP scope netmask.
dhcpscope_start_ip_addr
Not documented.
dhcpscope_size
Not documented.
dhcprange_failover_name
DHCP failover name.
dhcprange_state
Not documented.
dhcprange_class_name
The dhcprange_class_name is the name of the file class that will used for this object. The
name of dhcprange_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
prange_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcprange_class_parameters
The dhcprange_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcprange_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcprange_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcprange_lease_count
Not documented.
dhcprange_size
Not documented.
dhcprange_lease_percent
Not documented.
dhcprange_acl
DHCP range acl.
dhcpsn_id
The dhcpsn_id parameter is the Shared network identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsn_name
Shared network name.
vdhcp_parent_name
Not documented.

379
 DHCPv4 Range

dhcp_comment
Not documented.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp_version
Not documented.

380
 DHCPv4 Range

Name
dhcp_range_options_list — List the DHCP options set on a DHCPv4 range
Description
The service dhcp_range_options_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

381
 DHCPv4 Range

Name
dhcp_range_delete — Delete a DHCP range
Description
The service dhcp_range_delete allows to delete SOLIDserver database object. The service dh-
cp_range_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
scope_id
The scope_id parameter is the DHCP scope identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
range_id
The range_id parameter is the DHCP range identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcprange_name
DHCP range name.
range_name
DHCP range name.
start_addr
DHCP range start address.
dhcprange_start_addr
DHCP range start address.
end_addr
DHCP range end address.
dhcprange_end_addr
DHCP range end address.

382
 DHCPv4 Range

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

383
Chapter 30. DHCPv6 Range

384
 DHCPv6 Range

Name
dhcp6_range6_add — Add/Edit a DHCPv6 range
Description
The service dhcp6_range6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
dhcpscope6_name
DHCPv6 scope name.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
scope6_id
The scope6_id parameter is the DHCPv6 scope identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
start_addr
DHCPv6 range start address.
dhcprange6_start_addr
DHCPv6 range start address.
end_addr
DHCPv6 range end address.
dhcprange6_end_addr
DHCPv6 range end address.
failover_name
DHCPv6 failover name.
dhcprange6_failover_name
DHCPv6 failover name.

385
 DHCPv6 Range

acl
DHCPv6 range acl.
dhcprange6_acl
DHCPv6 range acl.
dhcprange6_class_name
The dhcprange6_class_name is the name of the file class that will used for this object. The
name of dhcprange6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcprange6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope6_class_parameters
The dhcpscope6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpscope6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpscope6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

386
 DHCPv6 Range

Name
dhcp6_range6_count — Number of DHCPv6 ranges
Description
The service dhcp6_range6_count allows to display the number of DHCPv6 ranges.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcprange6_id, delayed_time, dhcpscope6_id, dhc-

prange6_start_ip6_addr, dhcprange6_end_ip6_addr, dhcp6_id, dhcp6_type, dhcp6_name,
vdhcp6_parent_id, dhcpscope6_name, dhcpscope6_start_ip6_addr, dhcpscope6_end_ip6_ad-
dr, dhcpscope6_size, dhcpscope6_prefix, dhcprange6_failover_name, dhcprange6_state,
dhcprange6_class_name, dhcprange6_class_parameters, dhcprange6_lease_count, dhc-
prange6_size, dhcprange6_acl, dhcpsn6_id, dhcpsn6_name, vdhcp6_parent_name, dh-
cp6_comment, dhcpscope6_class_name, dhcp6_class_name, dhcp6_version.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

387
 DHCPv6 Range

Name
dhcp6_range6_list — List the DHCPv6 ranges
Description
The service dhcp6_range6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcprange6_id, delayed_time, dhcpscope6_id, dhc-

prange6_start_ip6_addr, dhcprange6_end_ip6_addr, dhcp6_id, dhcp6_type, dhcp6_name,
vdhcp6_parent_id, dhcpscope6_name, dhcpscope6_start_ip6_addr, dhcpscope6_end_ip6_ad-
dr, dhcpscope6_size, dhcpscope6_prefix, dhcprange6_failover_name, dhcprange6_state,
dhcprange6_class_name, dhcprange6_class_parameters, dhcprange6_lease_count, dhc-
prange6_size, dhcprange6_acl, dhcpsn6_id, dhcpsn6_name, vdhcp6_parent_name, dh-
cp6_comment, dhcpscope6_class_name, dhcp6_class_name, dhcp6_version.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

388
 DHCPv6 Range

delayed_time
Not documented.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcprange6_start_ip6_addr
Not documented.
dhcprange6_end_ip6_addr
Not documented.
dhcp6_id
Not documented.
dhcp6_type
Not documented.
dhcp6_name
Not documented.
vdhcp6_parent_id
Not documented.
dhcpscope6_name
Not documented.
dhcpscope6_start_ip6_addr
Not documented.
dhcpscope6_end_ip6_addr
Not documented.
dhcpscope6_size
Not documented.
dhcpscope6_prefix
Not documented.
dhcprange6_failover_name
Not documented.
dhcprange6_state
Not documented.
dhcprange6_class_name
The dhcprange6_class_name is the name of the file class that will used for this object. The
name of dhcprange6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcprange6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcprange6_class_parameters
The dhcprange6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcprange6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcprange6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcprange6_lease_count
Not documented.

389
 DHCPv6 Range

dhcprange6_size
Not documented.
dhcprange6_acl
Not documented.
dhcpsn6_id
Not documented.
dhcpsn6_name
Not documented.
vdhcp6_parent_name
Not documented.
dhcp6_comment
Not documented.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.

390
 DHCPv6 Range

Name
dhcp6_range6_info — Display the properties of a DHCPv6 range
Description
The service dhcp6_range6_info returns the information on the object specified in input.

Input Parameters
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcprange6_id
Not documented.
delayed_time
Not documented.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcprange6_start_ip6_addr
Not documented.
dhcprange6_end_ip6_addr
Not documented.
dhcp6_id
Not documented.
dhcp6_type
Not documented.
dhcp6_name
Not documented.
vdhcp6_parent_id
Not documented.
dhcpscope6_name
Not documented.
dhcpscope6_start_ip6_addr
Not documented.
dhcpscope6_end_ip6_addr
Not documented.
dhcpscope6_size
Not documented.
dhcpscope6_prefix
Not documented.

391
 DHCPv6 Range

dhcprange6_failover_name
Not documented.
dhcprange6_state
Not documented.
dhcprange6_class_name
The dhcprange6_class_name is the name of the file class that will used for this object. The
name of dhcprange6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcprange6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcprange6_class_parameters
The dhcprange6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcprange6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcprange6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcprange6_lease_count
Not documented.
dhcprange6_size
Not documented.
dhcprange6_acl
Not documented.
dhcpsn6_id
Not documented.
dhcpsn6_name
Not documented.
vdhcp6_parent_name
Not documented.
dhcp6_comment
Not documented.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.

392
 DHCPv6 Range

Name
dhcp6_range6_options6_list — List the DHCP options set on a DHCPv6 range
Description
The service dhcp6_range6_options6_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

393
 DHCPv6 Range

Name
dhcp6_range6_delete — Delete a DHCPv6 range
Description
The service dhcp6_range6_delete allows to delete SOLIDserver database object. The service
dhcp6_range6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
scope6_id
The scope6_id parameter is the DHCPv6 scope identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
range6_id
The range6_id parameter is the DHCPv6 range identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
start6_addr
DHCPv6 range start address.
dhcprange6_start_addr
DHCPv6 range start address.
end6_addr
DHCPv6 range end address.
dhcprange6_end_addr
DHCPv6 range end address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

394
Chapter 31. DHCPv4 Lease

395
 DHCPv4 Lease

Name
dhcp_range_lease_count — Number of DHCPv4 leases
Description
The service dhcp_range_lease_count allows to display the number of DHCPv4 leases.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcplease_remote_id, dhcplease_circuit_id, mac_vendor,

dhcplease_id, dhcplease_addr, dhcplease_ip_addr, dhcplease_mac_addr, dhcplease_cli-
ent_ident, dhcplease_time, dhcplease_end_time, dhcplease_period, percent, time_to_expire,
dhcplease_name, dhcplease_clientname, dhcpscope_id, dhcprange_id, dhcplease_domain,
dhcprange_name, dhcprange_start_addr, dhcprange_end_addr, dhcpscope_name, dhcp-
scope_size, dhcp_id, dhcp_name, dhcp_type, vdhcp_parent_id, vdhcp_parent_namek, dhc-
prange_failover_name, dhcprange_class_name, dhcpscope_class_name, dhcp_class_name,
vdhcp_parent_name, dhcp_version, ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

396
 DHCPv4 Lease

Name
dhcp_range_lease_list — List the DHCPv4 leases
Description
The service dhcp_range_lease_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcplease_remote_id, dhcplease_circuit_id, mac_vendor,

dhcplease_id, dhcplease_addr, dhcplease_ip_addr, dhcplease_mac_addr, dhcplease_cli-
ent_ident, dhcplease_time, dhcplease_end_time, dhcplease_period, percent, time_to_expire,
dhcplease_name, dhcplease_clientname, dhcpscope_id, dhcprange_id, dhcplease_domain,
dhcprange_name, dhcprange_start_addr, dhcprange_end_addr, dhcpscope_name, dhcp-
scope_size, dhcp_id, dhcp_name, dhcp_type, vdhcp_parent_id, vdhcp_parent_namek, dhc-
prange_failover_name, dhcprange_class_name, dhcpscope_class_name, dhcp_class_name,
vdhcp_parent_name, dhcp_version, ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcplease_remote_id
DHCP lease remote id.

397
 DHCPv4 Lease

dhcplease_circuit_id
DHCP lease circuit id.
mac_vendor
Not documented.
dhcplease_id
The dhcplease_id parameter is the DHCP lease identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcplease_addr
DHCP lease address.
dhcplease_ip_addr
Not documented.
dhcplease_mac_addr
DHCP lease mac address.
dhcplease_client_ident
DHCP lease client identifier.
dhcplease_time
DHCP lease time.
dhcplease_end_time
DHCP lease end time.
dhcplease_period
Not documented.
percent
Not documented.
time_to_expire
Not documented.
dhcplease_name
DHCP lease name.
dhcplease_clientname
DHCP lease clientname.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcplease_domain
DHCP lease domain.
dhcprange_name
DHCP range name.
dhcprange_start_addr
DHCP range start address.
dhcprange_end_addr
DHCP range end address.
dhcpscope_name
DHCP scope name.

398
 DHCPv4 Lease

dhcpscope_size
Not documented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
vdhcp_parent_namek
Not documented.
dhcprange_failover_name
DHCP failover name.
dhcprange_class_name
The dhcprange_class_name is the name of the file class that will used for this object. The
name of dhcprange_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
prange_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
vdhcp_parent_name
Not documented.
dhcp_version
Not documented.
ip_addr
IP address.

399
 DHCPv4 Lease

Name
dhcp_range_lease_info — Display the properties of a DHCPv4 lease
Description
The service dhcp_range_lease_info returns the information on the object specified in input.

Input Parameters
dhcplease_id
The dhcplease_id parameter is the DHCP lease identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcplease_remote_id
DHCP lease remote id.
dhcplease_circuit_id
DHCP lease circuit id.
mac_vendor
Not documented.
dhcplease_id
The dhcplease_id parameter is the DHCP lease identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcplease_addr
DHCP lease address.
dhcplease_ip_addr
Not documented.
dhcplease_mac_addr
DHCP lease mac address.
dhcplease_client_ident
DHCP lease client identifier.
dhcplease_time
DHCP lease time.
dhcplease_end_time
DHCP lease end time.
dhcplease_period
Not documented.
percent
Not documented.
time_to_expire
Not documented.
dhcplease_name
DHCP lease name.

400
 DHCPv4 Lease

dhcplease_clientname
DHCP lease clientname.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcplease_domain
DHCP lease domain.
dhcprange_name
DHCP range name.
dhcprange_start_addr
DHCP range start address.
dhcprange_end_addr
DHCP range end address.
dhcpscope_name
DHCP scope name.
dhcpscope_size
Not documented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
vdhcp_parent_namek
Not documented.
dhcprange_failover_name
DHCP failover name.
dhcprange_class_name
The dhcprange_class_name is the name of the file class that will used for this object. The
name of dhcprange_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
prange_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class

401
 DHCPv4 Lease

names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.
vdhcp_parent_name
Not documented.
dhcp_version
Not documented.
ip_addr
IP address.

402
 DHCPv4 Lease

Name
dhcp_lease_log_count — Number of DHCPv4 lease logs
Description
The service dhcp_lease_log_count allows to display the number of DHCPv4 lease log entries,
the data of the page Leases tracking in SOLIDserver GUI. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp_name, dhcp_id, dhcp_type, vdhcp_parent_id,

histo_time, histo_last_time, dhcplease_period, histo_state, dhcplease_addr, dhcplease_ip_ad-
dr, mac_addr, domain, name, dhcplease_id, dhcplease_histo_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

403
 DHCPv4 Lease

Name
dhcp_lease_log_list — List the DHCPv4 leases logs
Description
The service dhcp_lease_log_list allows to list the DHCPv4 lease log entries, the data of the page
Leases tracking in SOLIDserver GUI. The WHERE input parameter allows to filter the returned
rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp_name, dhcp_id, dhcp_type, vdhcp_parent_id,

histo_time, histo_last_time, dhcplease_period, histo_state, dhcplease_addr, dhcplease_ip_ad-
dr, mac_addr, domain, name, dhcplease_id, dhcplease_histo_id.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp_name
DHCP server name.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.

404
 DHCPv4 Lease

vdhcp_parent_id
Not documented.
histo_time
Not documented.
histo_last_time
Not documented.
dhcplease_period
Not documented.
histo_state
Not documented.
dhcplease_addr
DHCP lease address.
dhcplease_ip_addr
Not documented.
mac_addr
IP address MAC address.
domain
Not documented.
name
Rule name.
dhcplease_id
The dhcplease_id parameter is the DHCP lease identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcplease_histo_id
Not documented.

405
 DHCPv4 Lease

Name
dhcp_lease_delete — Delete a DHCPv4 lease
Description
The service dhcp_lease_delete allows to delete DHCPv4 leases from the database. You must
specify the lease to delete in the input.

Standard users, can only delete objects listed among their group resources, if and only if the
group they belong is granted the permission to execute the object deletion service. If you do not
have sufficient rights to execute the service, refer to the part Rights Management of the Adminis-
trator Guide, in the chapter Managing Groups.

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
lease_id
The lease_id parameter is the DHCP lease identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcplease_id
The dhcplease_id parameter is the DHCP lease identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
lease_addr
DHCP lease address.
dhcplease_addr
DHCP lease address.
lease_mac_addr
DHCP lease mac address.
dhcplease_mac_addr
DHCP lease mac address.
lease_client_ident
DHCP lease client identifier.
dhcplease_client_ident
DHCP lease client identifier.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

406
 DHCPv4 Lease

Name
dhcp_lease_manual_delete — Release a DHCPv4 lease
Description
The service dhcp_lease_manual_delete allows to delete SOLIDserver database object. The
service dhcp_lease_manual_delete needs to identify the object to delete with the input parameters
detailed in the next section. This service will be executed if the connected user running this service
is allowed to delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
dhcplease_id
The dhcplease_id parameter is the DHCP lease identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcplease_addr
DHCP IP address.
lease_addr
DHCP IP address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

407
Chapter 32. DHCPv6 Lease

408
 DHCPv6 Lease

Name
dhcp6_lease6_count — Number of DHCPv6 leases
Description
The service dhcp6_lease6_count allows to display the number of DHCPv6 leases.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcplease6_remote_id, dhcplease6_circuit_id,

mac_vendor, dhcplease6_id, dhcplease6_ip6_addr, dhcplease6_mac_addr, dhcplease6_cli-
ent_ident, dhcplease6_time, dhcplease6_end_time, dhcplease6_period, percent,
time_to_expire, dhcplease6_name, dhcplease6_clientname, dhcpscope6_id, dhcprange6_id,
dhcplease6_domain, dhcprange6_start_ip6_addr, dhcprange6_end_ip6_addr, dhcp-
scope6_name, dhcpscope6_size, dhcp6_id, dhcp6_name, dhcp6_type, vdhcp6_parent_id,
vdhcp6_parent_name, dhcprange6_failover_name, dhcprange6_class_name, dhcp-
scope6_class_name, dhcp6_class_name, dhcp6_version, ip6_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

409
 DHCPv6 Lease

Name
dhcp6_lease6_list — List the DHCPv6 leases
Description
The service dhcp6_lease6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcplease6_remote_id, dhcplease6_circuit_id,

mac_vendor, dhcplease6_id, dhcplease6_ip6_addr, dhcplease6_mac_addr, dhcplease6_cli-
ent_ident, dhcplease6_time, dhcplease6_end_time, dhcplease6_period, percent,
time_to_expire, dhcplease6_name, dhcplease6_clientname, dhcpscope6_id, dhcprange6_id,
dhcplease6_domain, dhcprange6_start_ip6_addr, dhcprange6_end_ip6_addr, dhcp-
scope6_name, dhcpscope6_size, dhcp6_id, dhcp6_name, dhcp6_type, vdhcp6_parent_id,
vdhcp6_parent_name, dhcprange6_failover_name, dhcprange6_class_name, dhcp-
scope6_class_name, dhcp6_class_name, dhcp6_version, ip6_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcplease6_remote_id
Not documented.

410
 DHCPv6 Lease

dhcplease6_circuit_id
Not documented.
mac_vendor
Not documented.
dhcplease6_id
Not documented.
dhcplease6_ip6_addr
Not documented.
dhcplease6_mac_addr
Not documented.
dhcplease6_client_ident
Not documented.
dhcplease6_time
Not documented.
dhcplease6_end_time
Not documented.
dhcplease6_period
Not documented.
percent
Not documented.
time_to_expire
Not documented.
dhcplease6_name
Not documented.
dhcplease6_clientname
Not documented.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcplease6_domain
Not documented.
dhcprange6_start_ip6_addr
Not documented.
dhcprange6_end_ip6_addr
Not documented.
dhcpscope6_name
Not documented.
dhcpscope6_size
Not documented.
dhcp6_id
Not documented.

411
 DHCPv6 Lease

dhcp6_name
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.
vdhcp6_parent_name
Not documented.
dhcprange6_failover_name
Not documented.
dhcprange6_class_name
The dhcprange6_class_name is the name of the file class that will used for this object. The
name of dhcprange6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcprange6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.
ip6_addr
IP6 address.

412
 DHCPv6 Lease

Name
dhcp6_lease6_info — Display the properties of a DHCPv6 lease
Description
The service dhcp6_lease6_info returns the information on the object specified in input.

Input Parameters
dhcplease6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcplease6_remote_id
Not documented.
dhcplease6_circuit_id
Not documented.
mac_vendor
Not documented.
dhcplease6_id
Not documented.
dhcplease6_ip6_addr
Not documented.
dhcplease6_mac_addr
Not documented.
dhcplease6_client_ident
Not documented.
dhcplease6_time
Not documented.
dhcplease6_end_time
Not documented.
dhcplease6_period
Not documented.
percent
Not documented.
time_to_expire
Not documented.
dhcplease6_name
Not documented.
dhcplease6_clientname
Not documented.

413
 DHCPv6 Lease

dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcplease6_domain
Not documented.
dhcprange6_start_ip6_addr
Not documented.
dhcprange6_end_ip6_addr
Not documented.
dhcpscope6_name
Not documented.
dhcpscope6_size
Not documented.
dhcp6_id
Not documented.
dhcp6_name
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.
vdhcp6_parent_name
Not documented.
dhcprange6_failover_name
Not documented.
dhcprange6_class_name
The dhcprange6_class_name is the name of the file class that will used for this object. The
name of dhcprange6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcprange6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_version
Not documented.

414
 DHCPv6 Lease

ip6_addr
IP6 address.

415
 DHCPv6 Lease

Name
dhcp6_lease6_log_count — Number of DHCPv6 lease logs
Description
The service dhcp6_lease6_log_count allows to display the number of DHCPv6 lease log entries,
the data of the page Leases tracking in SOLIDserver GUI. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp6_name, dhcp6_id, dhcp6_type, vdhcp6_parent_id,

histo_time, histo_last_time, dhcplease6_period, histo_state, dhcplease6_ip6_addr,
mac_addr, domain, name, dhcplease6_id, dhcplease6_histo_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

416
 DHCPv6 Lease

Name
dhcp6_lease6_log_list — List the DHCPv6 leases logs
Description
The service dhcp6_lease6_log_list allows to list the DHCPv6 lease log entries, the data of the
page Leases tracking in SOLIDserver GUI. The WHERE input parameter allows to filter the re-
turned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp6_name, dhcp6_id, dhcp6_type, vdhcp6_parent_id,

histo_time, histo_last_time, dhcplease6_period, histo_state, dhcplease6_ip6_addr,
mac_addr, domain, name, dhcplease6_id, dhcplease6_histo_id.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp6_name
Not documented.
dhcp6_id
Not documented.
dhcp6_type
Not documented.

417
 DHCPv6 Lease

vdhcp6_parent_id
Not documented.
histo_time
Not documented.
histo_last_time
Not documented.
dhcplease6_period
Not documented.
histo_state
Not documented.
dhcplease6_ip6_addr
Not documented.
mac_addr
IP address MAC address.
domain
Not documented.
name
Rule name.
dhcplease6_id
Not documented.
dhcplease6_histo_id
Not documented.

418
 DHCPv6 Lease

Name
dhcp6_lease6_delete — Delete a DHCPv6 lease
Description
The service dhcp6_lease6_delete allows to delete DHCPv6 leases from the database. You must
specify the lease to delete in the input.

Standard users, can only delete objects listed among their group resources, if and only if the
group they belong is granted the permission to execute the object deletion service. If you do not
have sufficient rights to execute the service, refer to the part Rights Management of the Adminis-
trator Guide, in the chapter Managing Groups.

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
lease6_id
The lease6_id parameter is the DHCPv6 lease identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcplease6_id
The dhcplease6_id parameter is the DHCPv6 lease identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
lease6_addr
DHCPv6 lease address.
dhcplease6_addr
DHCPv6 lease address.
lease6_mac_addr
DHCPv6 lease mac address.
dhcplease6_mac_addr
DHCPv6 lease mac address.
lease6_client_ident
DHCPv6 lease client identifier.
dhcplease6_client_ident
DHCPv6 lease client identifier.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

419
 DHCPv6 Lease

Name
dhcp6_lease6_manual_delete — Release a DHCPv6 lease
Description
The service dhcp6_lease6_manual_delete allows to delete SOLIDserver database object. The
service dhcp6_lease6_manual_delete needs to identify the object to delete with the input para-
meters detailed in the next section. This service will be executed if the connected user running
this service is allowed to delete the concerned object

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
dhcplease6_id
The dhcplease6_id parameter is the DHCPv6 lease identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcplease6_addr
DHCPv6 IP address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

420
Chapter 33. DHCPv4 Static

421
 DHCPv4 Static

Name
dhcp_static_add — Add/Edit a DHCPv4 static
Description
The service dhcp_static_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
ip_id
The DHCP server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
dhcp_ip_id
The dhcp_ip_id parameter is the DHCP server address identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
static_id
The static_id parameter is the DHCP static identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcphost_id
The dhcphost_id parameter is the DHCP static identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
static_name
DHCP static name.
dhcphost_name
DHCP static name.
static_ip_addr
DHCP static address.
static_addr
DHCP static address.
dhcphost_addr
DHCP static address.

422
 DHCPv4 Static

static_mac_addr
DHCP static mac address.
dhcphost_mac_addr
DHCP static mac address.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpgroup_name
DHCP group name.
dhcpstatic_class_name
The dhcpstatic_class_name is the name of the file class that will used for this object. The
name of dhcpstatic_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcpstat-
ic_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcphost_class_name
The dhcphost_class_name is the name of the file class that will used for this object. The
name of dhcphost_class_name must include the directory of the class. The global and default
class names are reserved by the system and must never be used. For example a dhc-
phost_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpstatic_class_parameters
The dhcpstatic_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpstatic_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dhcpstatic_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
dhcphost_class_parameters
The dhcphost_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcphost_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dhcphost_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

423
 DHCPv4 Static

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

424
 DHCPv4 Static

Name
dhcp_static_count — Number of DHCPv4 statics
Description
The service dhcp_static_count allows to display the number of DHCPv4 statics.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcphost_time, dhcphost_end_time, dhcpscope_row_en-

abled, dhcpscope_start_ip_addr, dhcpscope_end_ip_addr, dhcpscope_net_mask, dhcp-
scope_net_addr, mac_vendor, dhcphost_id, dhcp_id, dhcphost_mac_addr, dhcphost_addr,
dhcphost_ip_addr, dhcphost_name, dhcphost_domain, dhcp_name, dhcp_type, vdhcp_par-
ent_id, dhcphost_state, dhcpscope_id, dhcpscope_name, delayed_create_time, dhcp-
scope_size, dhcpscope_site_id, delayed_delete_time, dhcpgroup_id, dhcpgroup_name,
dhcphost_custom1, dhcphost_custom2, dhcphost_custom3, dhcphost_class_name, dhc-
phost_class_parameters, vdhcp_parent_name, dhcpscope_class_name, dhcp_class_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

425
 DHCPv4 Static

Name
dhcp_static_list — List the DHCPv4 statics
Description
The service dhcp_static_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use the service dhcp_static_list. The rows returned
to the user running the service depend on the resources granted to the group they belong to.
The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcphost_time, dhcphost_end_time, dhcpscope_row_en-

abled, dhcpscope_start_ip_addr, dhcpscope_end_ip_addr, dhcpscope_net_mask, dhcp-
scope_net_addr, mac_vendor, dhcphost_id, dhcp_id, dhcphost_mac_addr, dhcphost_addr,
dhcphost_ip_addr, dhcphost_name, dhcphost_domain, dhcp_name, dhcp_type, vdhcp_par-
ent_id, dhcphost_state, dhcpscope_id, dhcpscope_name, delayed_create_time, dhcp-
scope_size, dhcpscope_site_id, delayed_delete_time, dhcpgroup_id, dhcpgroup_name,
dhcphost_custom1, dhcphost_custom2, dhcphost_custom3, dhcphost_class_name, dhc-
phost_class_parameters, vdhcp_parent_name, dhcpscope_class_name, dhcp_class_name.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcphost_time
Not documented.

426
 DHCPv4 Static

dhcphost_end_time
Not documented.
dhcpscope_row_enabled
Not documented.
dhcpscope_start_ip_addr
Not documented.
dhcpscope_end_ip_addr
Not documented.
dhcpscope_net_mask
DHCP scope netmask.
dhcpscope_net_addr
DHCP scope address.
mac_vendor
Not documented.
dhcphost_id
The dhcphost_id parameter is the DHCP static identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcphost_mac_addr
DHCP static mac address.
dhcphost_addr
DHCP static address.
dhcphost_ip_addr
Not documented.
dhcphost_name
DHCP static name.
dhcphost_domain
Not documented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcphost_state
Not documented.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpscope_name
DHCP scope name.
delayed_create_time
Not documented.

427
 DHCPv4 Static

dhcpscope_size
Not documented.
dhcpscope_site_id
The dhcpscope_site_id parameter is the DHCP Scope space identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
delayed_delete_time
Not documented.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpgroup_name
DHCP group name.
dhcphost_class_name
The dhcphost_class_name is the name of the file class that will used for this object. The
name of dhcphost_class_name must include the directory of the class. The global and default
class names are reserved by the system and must never be used. For example a dhc-
phost_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcphost_class_parameters
The dhcphost_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcphost_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dhcphost_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
vdhcp_parent_name
Not documented.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.

428
 DHCPv4 Static

Name
dhcp_static_info — Display the properties of a DHCPv4 static
Description
The service dhcp_static_info returns the information on the object specified in input.

Input Parameters
dhcpstatic_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcphost_time
Not documented.
dhcphost_end_time
Not documented.
dhcpscope_row_enabled
Not documented.
dhcpscope_start_ip_addr
Not documented.
dhcpscope_end_ip_addr
Not documented.
dhcpscope_net_mask
DHCP scope netmask.
dhcpscope_net_addr
DHCP scope address.
mac_vendor
Not documented.
dhcphost_id
The dhcphost_id parameter is the DHCP static identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcphost_mac_addr
DHCP static mac address.
dhcphost_addr
DHCP static address.
dhcphost_ip_addr
Not documented.
dhcphost_name
DHCP static name.

429
 DHCPv4 Static

dhcphost_domain
Not documented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcphost_state
Not documented.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpscope_name
DHCP scope name.
delayed_create_time
Not documented.
dhcpscope_size
Not documented.
dhcpscope_site_id
The dhcpscope_site_id parameter is the DHCP Scope space identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
delayed_delete_time
Not documented.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpgroup_name
DHCP group name.
dhcphost_class_name
The dhcphost_class_name is the name of the file class that will used for this object. The
name of dhcphost_class_name must include the directory of the class. The global and default
class names are reserved by the system and must never be used. For example a dhc-
phost_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcphost_class_parameters
The dhcphost_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcphost_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dhcphost_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
vdhcp_parent_name
Not documented.
dhcpscope_class_name
The dhcpscope_class_name is the name of the file class that will used for this object. The
name of dhcpscope_class_name must include the directory of the class.The global and default

430
 DHCPv4 Static

class names are reserved by the system and must never be used. For example a dhcp-
scope_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp_class_name
The dhcp_class_name is the name of the file class that will used for this object. The name
of dhcp_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp_class_name
parameter could be set to: my_favorite_dir/my_class.class.

431
 DHCPv4 Static

Name
dhcp_static_options_list — List the DHCP options set on a DHCPv4 static
Description
The service dhcp_static_options_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use the service dhcp_static_options_list. The
rows returned to the user running the service depend on the resources granted to the group they
belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
dhcpstatic_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

432
 DHCPv4 Static

Name
dhcp_static_delete — Delete a DHCPv4 static
Description
The service dhcp_static_delete allows to delete SOLIDserver database object. The service dh-
cp_static_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
scope_id
The scope_id parameter is the DHCP scope identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcphost_id
The dhcphost_id parameter is the DHCP static identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
static_id
The static_id parameter is the DHCP static identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcphost_name
DHCP static name.
static_name
DHCP static name.
dhcphost_mac_addr
DHCP static mac address.
static_mac_addr
DHCP static mac address.
dhcphost_addr
DHCP static address.
static_addr
DHCP static address.

433
 DHCPv4 Static

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

434
Chapter 34. DHCPv6 Static

435
 DHCPv6 Static

Name
dhcp6_static6_add — Add/Edit a DHCPv6 static
Description
The service dhcp6_static6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
ip6_id
The ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp6_ip6_id
The dhcp6_ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
static6_id
The static6_id parameter is the DHCPv6 static identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcphost6_id
The dhcphost6_id parameter is the DHCPv6 static identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
static6_name
DHCPv6 static name.
dhcphost6_name
DHCPv6 static name.
static6_ip_addr
DHCPv6 static address.
static6_addr
DHCPv6 static address.
dhcphost6_addr
DHCPv6 static address.

436
 DHCPv6 Static

static6_mac_addr
DHCPv6 static mac address.
dhcphost6_mac_addr
DHCPv6 static mac address.
dhcpgroup6_id
The dhcpgroup6_id parameter is the DHCPv6 group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpgroup6_name
DHCPv6 group name.
dhcpstatic6_class_name
The dhcpstatic6_class_name is the name of the file class that will used for this object. The
name of dhcpstatic6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpstatic6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcphost6_class_name
The dhcphost6_class_name is the name of the file class that will used for this object. The
name of dhcphost6_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
phost6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcpstatic6_class_parameters
The dhcpstatic6_class_parameters parameter is a data container used to store your custom-
ized meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcpstatic6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcpstatic6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
dhcphost6_class_parameters
The dhcphost6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcphost6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcphost6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

437
 DHCPv6 Static

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

438
 DHCPv6 Static

Name
dhcp6_static6_count — Number of DHCPv6 statics
Description
The service dhcp6_static6_count allows to display the number of DHCPv6 statics.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcphost6_time, dhcphost6_end_time, dhcp-

scope6_row_enabled, dhcpscope6_start_ip6_addr, dhcpscope6_end_ip6_addr, mac_vendor,
dhcphost6_id, dhcp6_id, dhcphost6_mac_addr, dhcphost6_ip6_addr, dhcphost6_name,
dhcphost6_domain, dhcp6_name, dhcp6_type, vdhcp6_parent_id, dhcphost6_state, dhcp-
scope6_id, dhcpscope6_name, dhcpscope6_size, dhcpscope6_site_id, delayed_time, dhcp-
group6_id, dhcpgroup6_name, dhcphost6_class_name, dhcphost6_class_parameters, vdh-
cp6_parent_name, dhcpscope6_class_name, dhcp6_class_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

439
 DHCPv6 Static

Name
dhcp6_static6_list — List the DHCPv6 statics
Description
The service dhcp6_static6_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use the service dhcp6_static6_list.The rows returned
to the user running the service depend on the resources granted to the group they belong to.
The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcphost6_time, dhcphost6_end_time, dhcp-

scope6_row_enabled, dhcpscope6_start_ip6_addr, dhcpscope6_end_ip6_addr, mac_vendor,
dhcphost6_id, dhcp6_id, dhcphost6_mac_addr, dhcphost6_ip6_addr, dhcphost6_name,
dhcphost6_domain, dhcp6_name, dhcp6_type, vdhcp6_parent_id, dhcphost6_state, dhcp-
scope6_id, dhcpscope6_name, dhcpscope6_size, dhcpscope6_site_id, delayed_time, dhcp-
group6_id, dhcpgroup6_name, dhcphost6_class_name, dhcphost6_class_parameters, vdh-
cp6_parent_name, dhcpscope6_class_name, dhcp6_class_name.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcphost6_time
Not documented.

440
 DHCPv6 Static

dhcphost6_end_time
Not documented.
dhcpscope6_row_enabled
Not documented.
dhcpscope6_start_ip6_addr
Not documented.
dhcpscope6_end_ip6_addr
Not documented.
mac_vendor
Not documented.
dhcphost6_id
Not documented.
dhcp6_id
Not documented.
dhcphost6_mac_addr
Not documented.
dhcphost6_ip6_addr
Not documented.
dhcphost6_name
Not documented.
dhcphost6_domain
Not documented.
dhcp6_name
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.
dhcphost6_state
Not documented.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcpscope6_name
Not documented.
dhcpscope6_size
Not documented.
dhcpscope6_site_id
Not documented.
delayed_time
Not documented.
dhcpgroup6_id
Not documented.
dhcpgroup6_name
Not documented.

441
 DHCPv6 Static

dhcphost6_class_name
The dhcphost6_class_name is the name of the file class that will used for this object. The
name of dhcphost6_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
phost6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcphost6_class_parameters
The dhcphost6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcphost6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcphost6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
vdhcp6_parent_name
Not documented.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.

442
 DHCPv6 Static

Name
dhcp6_static6_info — Display the properties of a DHCPv6 static
Description
The service dhcp6_static6_info returns the information on the object specified in input.

Input Parameters
dhcpstatic6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcphost6_time
Not documented.
dhcphost6_end_time
Not documented.
dhcpscope6_row_enabled
Not documented.
dhcpscope6_start_ip6_addr
Not documented.
dhcpscope6_end_ip6_addr
Not documented.
mac_vendor
Not documented.
dhcphost6_id
Not documented.
dhcp6_id
Not documented.
dhcphost6_mac_addr
Not documented.
dhcphost6_ip6_addr
Not documented.
dhcphost6_name
Not documented.
dhcphost6_domain
Not documented.
dhcp6_name
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.

443
 DHCPv6 Static

dhcphost6_state
Not documented.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcpscope6_name
Not documented.
dhcpscope6_size
Not documented.
dhcpscope6_site_id
Not documented.
delayed_time
Not documented.
dhcpgroup6_id
Not documented.
dhcpgroup6_name
Not documented.
dhcphost6_class_name
The dhcphost6_class_name is the name of the file class that will used for this object. The
name of dhcphost6_class_name must include the directory of the class.The global and default
class names are reserved by the system and must never be used. For example a dhc-
phost6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcphost6_class_parameters
The dhcphost6_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dhcphost6_class_parameters parameter accepts several
meta-data va l u e s set in the fo l l ow i n g URL style fo r m a t :
metadata1=value1&metadata2=value2&. To be accepted by dhcphost6_class_parameters
parameter the URL value must be encoded in URL format (see RFC 3986).
vdhcp6_parent_name
Not documented.
dhcpscope6_class_name
The dhcpscope6_class_name is the name of the file class that will used for this object. The
name of dhcpscope6_class_name must include the directory of the class. The global and
default class names are reserved by the system and must never be used. For example a
dhcpscope6_class_name parameter could be set to: my_favorite_dir/my_class.class.
dhcp6_class_name
The dhcp6_class_name is the name of the file class that will used for this object. The name
of dhcp6_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a dhcp6_class_name
parameter could be set to: my_favorite_dir/my_class.class.

444
 DHCPv6 Static

Name
dhcp6_static6_options6_list — List the DHCP options set on a DHCPv6 static
Description
The service dhcp6_static6_options6_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use the service dhcp6_static6_op-
tions6_list. The rows returned to the user running the service depend on the resources granted
to the group they belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
dhcpstatic6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

445
 DHCPv6 Static

Name
dhcp6_static6_delete — Delete a DHCPv6 static
Description
The service dhcp6_static6_delete allows to delete SOLIDserver database object. The service
dhcp6_static6_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
scope6_id
The scope6_id parameter is the DHCPv6 scope identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcphost6_id
The dhcphost6_id parameter is the DHCPv6 static identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
static6_id
The static6_id parameter is the DHCPv6 static identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcphost6_name
DHCPv6 static name.
static6_name
DHCPv6 static name.
dhcphost6_mac_addr
DHCPv6 static mac address.
static6_mac_addr
DHCPv6 static mac address.
dhcphost6_addr
DHCPv6 static address.
static6_addr
DHCPv6 static address.

446
 DHCPv6 Static

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

447
Chapter 35. DHCPv4 Options

448
 DHCPv4 Options

Name
dhcp_option_add — Add/Edit/Delete a DHCP option on DHCPv4 objects
Description
The service dhcp_option_add allows to manage the DHCP options set on DHCPv4 objects, you
can add, edit and delete options via this service.

You must identify the DHCPv4 object to configure its options. Setting the value of an already
configured option edits it. During an edition, all the specified parameters update and complete
the existing object configuration. To remove an option, set its value to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcpscope_id
The dhcpscope_id parameter is the DHCP scope identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
scope_id
The scope_id parameter is the DHCP scope identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpscope_name
DHCP scope name.
scope_name
DHCP scope name.
dhcprange_id
The dhcprange_id parameter is the DHCP range identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
range_id
The range_id parameter is the DHCP range identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcprange_name
DHCP range name.
range_name
DHCP range name.
dhcphost_id
The dhcphost_id parameter is the DHCP static identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.

449
 DHCPv4 Options

host_id
The host_id parameter is the DHCP static identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcphost_name
DHCP static name.
host_name
DHCP static name.
dhcpgroup_id
The dhcpgroup_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
group_id
The group_id parameter is the DHCP group identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpgroup_name
DHCP group name.
group_name
DHCP group name.
dhcpacl_id
The dhcpacl_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
acl_id
The acl_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
dhcpacl_name
DHCP acl name.
acl_name
DHCP acl name.
dhcpacl_data_id
The dhcpacl_data_id parameter is the DHCP acl data identifier (ID).This identifier is a unique
numeric key value that is automatically incremented.
acl_data_id
The acl_data_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
acl_data_value
DHCP acl data value.
dhcpacl_data_name
DHCP acl data value.
acl_data_name
DHCP acl data value.
dhcpoption_name
DHCP option name.
option
DHCP option name.
dhcpoption_value
DHCP option value.

450
 DHCPv4 Options

value
DHCP option value.
dhcpoption_type
DHCP option type.
option_type
DHCP option type.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

451
Chapter 36. DHCPv6 Options

452
 DHCPv6 Options

Name
dhcp6_option6_add — Add/Edit/Delete a DHCP option on DHCPv6 objects
Description
The service dhcp6_option6_add allows to manage the DHCP options set on DHCPv6 objects,
you can add, edit and delete options via this service.

You must identify the DHCPv6 object to configure its options. Setting the value of an already
configured option edits it. During an edition, all the specified parameters update and complete
the existing object configuration. To remove an option, set its value to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
dhcp6_id
The DHCPv6 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcpscope6_id
The DHCPv6 scope identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
scope6_id
The scope6_id parameter is the DHCPv6 scope identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcpscope6_name
DHCPv6 scope name.
scope6_name
DHCPv6 scope name.
dhcprange6_id
The DHCPv6 range identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
range6_id
The range6_id parameter is the DHCPv6 range identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcprange6_start_addr
DHCPv6 range start address.
dhcphost6_id
The dhcphost6_id parameter is the DHCPv6 static identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
host6_id
The host6_id parameter is the DHCPv6 static identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.

453
 DHCPv6 Options

dhcphost6_name
DHCPv6 static name.
host6_name
DHCPv6 static name.
dhcpgroup6_id
The dhcpgroup6_id parameter is the DHCPv6 group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
group6_id
The group6_id parameter is the DHCPv6 group identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcpgroup6_name
DHCPv6 group name.
group6_name
DHCPv6 group name.
dhcpacl6_id
The dhcpacl6_id parameter is the DHCPv6 acl identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
acl6_id
The acl6_id parameter is the DHCPv6 acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpacl6_name
DHCPv6 acl name.
acl6_name
DHCPv6 acl name.
dhcpacl6_data6_id
The dhcpacl6_data6_id parameter is the DHCPv6 acl data identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
acl6_data6_id
The acl6_data6_id parameter is the DHCPv6 acl data identifier (ID).This identifier is a unique
numeric key value that is automatically incremented.
acl6_data6_value
DHCPv6 acl data value.
dhcpacl6_data6_name
DHCPv6 acl data value.
acl6_data6_name
DHCPv6 acl data value.
dhcpoption6_name
DHCPv6 option name.
option6
DHCPv6 option name.
dhcpoption6_value
DHCPv6 option value.
value6
DHCPv6 option value.
dhcpoption6_type
DHCPv6 option type.

454
 DHCPv6 Options

option6_type
DHCPv6 option type.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

455
Chapter 37. DHCPv4 Optiondef

456
 DHCPv4 Optiondef

Name
dhcp_optiondef_add — Add/Edit a DHCPv4 option definition
Description
The service dhcp_optiondef_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcpoptiondef_id
The dhcpoptiondef_id parameter is the DHCP optiondef identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpoptiondef_name
DHCP optiondef name.
option
DHCP optiondef name.
dhcpoptiondef_universe
DHCP optiondef universe.
option_universe
DHCP optiondef universe.
dhcpoptiondef_code
DHCP optiondef code.
option_code
DHCP optiondef code.
dhcpoptiondef_type
DHCP optiondef type.
option_format
DHCP optiondef type.
dhcpoptiondef_isnew
DHCP optiondef is new (custom option).
norefresh_server
internal use.

457
 DHCPv4 Optiondef

add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

458
 DHCPv4 Optiondef

Name
dhcp_optiondef_count — Number of DHCPv4 option definitions
Description
The service dhcp_optiondef_count allows to display the number of DHCPv4 option definitions.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp_parent_id, dhcp_type, dhcpoptiondef_id, dh-

cp_name, dhcpoptiondef_universe, dhcpoptiondef_name, dhcpoptiondef_code, dhcpop-
tiondef_type, dhcpoptiondef_isnew, delayed_create_time, delayed_delete_time, dhcp_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

459
 DHCPv4 Optiondef

Name
dhcp_optiondef_list — List the DHCPv4 option definitions
Description
The service dhcp_optiondef_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp_parent_id, dhcp_type, dhcpoptiondef_id, dh-

cp_name, dhcpoptiondef_universe, dhcpoptiondef_name, dhcpoptiondef_code, dhcpop-
tiondef_type, dhcpoptiondef_isnew, delayed_create_time, delayed_delete_time, dhcp_id.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp_parent_id
Not documented.
dhcp_type
DHCP server type.
dhcpoptiondef_id
The dhcpoptiondef_id parameter is the DHCP optiondef identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.

460
 DHCPv4 Optiondef

dhcp_name
DHCP server name.
dhcpoptiondef_universe
DHCP optiondef universe.
dhcpoptiondef_name
DHCP optiondef name.
dhcpoptiondef_code
DHCP optiondef code.
dhcpoptiondef_type
DHCP optiondef type.
dhcpoptiondef_isnew
DHCP optiondef is new (custom option).
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

461
 DHCPv4 Optiondef

Name
dhcp_optiondef_info — Display the properties of a DHCPv4 option definition
Description
The service dhcp_optiondef_info returns the information on the object specified in input.

Input Parameters
dhcpoptiondef_id
The dhcpoptiondef_id parameter is the DHCP optiondef identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp_parent_id
Not documented.
dhcp_type
DHCP server type.
dhcpoptiondef_id
The dhcpoptiondef_id parameter is the DHCP optiondef identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcp_name
DHCP server name.
dhcpoptiondef_universe
DHCP optiondef universe.
dhcpoptiondef_name
DHCP optiondef name.
dhcpoptiondef_code
DHCP optiondef code.
dhcpoptiondef_type
DHCP optiondef type.
dhcpoptiondef_isnew
DHCP optiondef is new (custom option).
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

462
 DHCPv4 Optiondef

Name
dhcp_optiondef_delete — Delete a DHCPv4 option definition
Description
The service dhcp_optiondef_delete allows to delete SOLIDserver database object. The service
dhcp_optiondef_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcpoptiondef_id
The dhcpoptiondef_id parameter is the DHCP optiondef identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpoptiondef_name
DHCP optiondef name.
option
DHCP optiondef name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

463
Chapter 38. DHCPv6 Optiondef

464
 DHCPv6 Optiondef

Name
dhcp6_optiondef6_add — Add/Edit a DHCPv6 option definition
Description
The service dhcp6_optiondef6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcpoptiondef6_id
The dhcpoptiondef6_id parameter is the DHCPv6 optiondef identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpoptiondef6_name
DHCPv6 optiondef name.
option6
DHCPv6 optiondef name.
dhcpoptiondef6_universe
DHCPv6 optiondef universe.
option6_universe
DHCPv6 optiondef universe.
dhcpoptiondef6_code
DHCPv6 optiondef code.
option6_code
DHCPv6 optiondef code.
dhcpoptiondef6_type
DHCPv6 optiondef type.
option6_format
DHCPv6 optiondef type.
dhcpoptiondef6_isnew
DHCPv6 optiondef is new (custom option).
norefresh_server
internal use.

465
 DHCPv6 Optiondef

add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

466
 DHCPv6 Optiondef

Name
dhcp6_optiondef6_count — Number of DHCPv6 option definitions
Description
The service dhcp6_optiondef6_count allows to display the number of DHCPv6 option definitions.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp6_parent_id, dhcp6_type, dhcpoptiondef6_id,

dhcp6_name, dhcpoptiondef6_universe, dhcpoptiondef6_name, dhcpoptiondef6_code, dhc-
poptiondef6_type, dhcpoptiondef6_isnew, delayed_time, dhcp6_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

467
 DHCPv6 Optiondef

Name
dhcp6_optiondef6_list — List the DHCPv6 option definition
Description
The service dhcp6_optiondef6_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: vdhcp6_parent_id, dhcp6_type, dhcpoptiondef6_id,

dhcp6_name, dhcpoptiondef6_universe, dhcpoptiondef6_name, dhcpoptiondef6_code, dhc-
poptiondef6_type, dhcpoptiondef6_isnew, delayed_time, dhcp6_id.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp6_parent_id
Not documented.
dhcp6_type
Not documented.
dhcpoptiondef6_id
Not documented.

468
 DHCPv6 Optiondef

dhcp6_name
Not documented.
dhcpoptiondef6_universe
Not documented.
dhcpoptiondef6_name
Not documented.
dhcpoptiondef6_code
Not documented.
dhcpoptiondef6_type
Not documented.
dhcpoptiondef6_isnew
Not documented.
delayed_time
Not documented.
dhcp6_id
Not documented.

469
 DHCPv6 Optiondef

Name
dhcp6_optiondef6_info — Display the properties of a DHCPv6 option definition
Description
The service dhcp6_optiondef6_info returns the information on the object specified in input.

Input Parameters
dhcpoptiondef6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
vdhcp6_parent_id
Not documented.
dhcp6_type
Not documented.
dhcpoptiondef6_id
Not documented.
dhcp6_name
Not documented.
dhcpoptiondef6_universe
Not documented.
dhcpoptiondef6_name
Not documented.
dhcpoptiondef6_code
Not documented.
dhcpoptiondef6_type
Not documented.
dhcpoptiondef6_isnew
Not documented.
delayed_time
Not documented.
dhcp6_id
Not documented.

470
 DHCPv6 Optiondef

Name
dhcp6_optiondef6_delete — Delete a DHCPv6 option definition
Description
The service dhcp6_optiondef6_delete allows to delete SOLIDserver database object. The service
dhcp6_optiondef6_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcpoptiondef6_id
The dhcpoptiondef6_id parameter is the DHCPv6 optiondef identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpoptiondef6_name
DHCPv6 optiondef name.
option6
DHCPv6 optiondef name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

471
Chapter 39. DHCPv4 ACL and ACL
Entries

472
 DHCPv4 ACL and ACL Entries

Name
dhcp_acl_add — Add/Edit a DHCP ACL
Description
The service dhcp_acl_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
ip_id
The DHCP server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
dhcp_ip_id
The dhcp_ip_id parameter is the DHCP server address identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpclass_name
DHCP acl name.
dhcpclass_match
DHCP acl match.
dhcpclass_spawnwith
DHCP acl spawnwith.
dhcpclass_statement
DHCP acl statement.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.

473
 DHCPv4 ACL and ACL Entries

no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

474
 DHCPv4 ACL and ACL Entries

Name
dhcp_acl_delete — Delete a DHCP ACL
Description
The service dhcp_acl_delete allows to delete SOLIDserver database object. The service dh-
cp_acl_delete needs to identify the object to delete with the input parameters detailed in the next
section. This service will be executed if the connected user running this service is allowed to
delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
acl_id
The acl_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
dhcpclass_name
DHCP acl name.
acl_name
DHCP acl name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

475
 DHCPv4 ACL and ACL Entries

Name
dhcp_acl_data_add — Add/Edit a DHCP ACL entry
Description
The service dhcp_acl_data_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
ip_id
The DHCP server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
dhcp_ip_id
The dhcp_ip_id parameter is the DHCP server address identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpsubclass_value
DHCP acl data value.
dhcpsubclass_id
The dhcpsubclass_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpclass_name
DHCP acl name.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

476
 DHCPv4 ACL and ACL Entries

check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

477
 DHCPv4 ACL and ACL Entries

Name
dhcp_acl_data_delete — Delete a DHCP ACL entry
Description
The service dhcp_acl_data_delete allows to delete SOLIDserver database object. The service
dhcp_acl_data_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
acl_id
The acl_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
dhcpclass_name
DHCP acl name.
acl_name
DHCP acl name.
dhcpsubclass_id
The dhcpsubclass_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
acl_data_id
The acl_data_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpsubclass_value
DHCP acl data value.
acl_data_value
DHCP acl data value.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

478
 DHCPv4 ACL and ACL Entries

Name
dhcp_class_count — Number of DHCP ACLs
Description
The service dhcp_class_count allows to display the number of DHCP ACLs.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp_id, dhcp_name, dhcp_type, vdhcp_parent_id,

dhcpclass_id, dhcpclass_name, dhcpclass_match, dhcpclass_spawnwith, dhcpclass_state-
ment, delayed_create_time, delayed_delete_time.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

479
 DHCPv4 ACL and ACL Entries

Name
dhcp_class_list — List all the DHCP ACLs
Description
The service dhcp_class_list allows to list the DHCP ACLs whether they are used or not.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcp_id, dhcp_name, dhcp_type, vdhcp_parent_id,

dhcpclass_id, dhcpclass_name, dhcpclass_match, dhcpclass_spawnwith, dhcpclass_state-
ment, delayed_create_time, delayed_delete_time.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.

480
 DHCPv4 ACL and ACL Entries

dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpclass_name
DHCP acl name.
dhcpclass_match
DHCP acl match.
dhcpclass_spawnwith
DHCP acl spawnwith.
dhcpclass_statement
DHCP acl statement.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

481
 DHCPv4 ACL and ACL Entries

Name
dhcp_class_info — Display the properties of a DHCP ACL
Description
The service dhcp_class_info returns the information on the object specified in input.

Input Parameters
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpclass_name
DHCP acl name.
dhcpclass_match
DHCP acl match.
dhcpclass_spawnwith
DHCP acl spawnwith.
dhcpclass_statement
DHCP acl statement.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

482
 DHCPv4 ACL and ACL Entries

Name
dhcp_class_options_list — List the DHCP options set on a DHCP ACL
Description
The service dhcp_class_options_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

483
 DHCPv4 ACL and ACL Entries

Name
dhcp_subclass_count — Number of DHCP ACL entries
Description
The service dhcp_subclass_count allows to display the number of DHCP ACL entries.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpsubclass_id, dhcp_id, dhcp_name, dhcp_type,

vdhcp_parent_id, dhcpclass_name, dhcpclass_id, dhcpsubclass_value, delayed_create_time,
delayed_delete_time.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

484
 DHCPv4 ACL and ACL Entries

Name
dhcp_subclass_list — List all the DHCP ACL entries
Description
The service dhcp_subclass_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpsubclass_id, dhcp_id, dhcp_name, dhcp_type,

vdhcp_parent_id, dhcpclass_name, dhcpclass_id, dhcpsubclass_value, delayed_create_time,
delayed_delete_time.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpsubclass_id
The dhcpsubclass_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.

485
 DHCPv4 ACL and ACL Entries

dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpclass_name
DHCP acl name.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpsubclass_value
DHCP acl data value.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

486
 DHCPv4 ACL and ACL Entries

Name
dhcp_subclass_info — Display the properties of a DHCP ACL entry
Description
The service dhcp_subclass_info returns the information on the object specified in input.

Input Parameters
dhcpsubclass_id
The dhcpsubclass_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpsubclass_id
The dhcpsubclass_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp_id
The dhcp_id parameter is the DHCP server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcp_name
DHCP server name.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpclass_name
DHCP acl name.
dhcpclass_id
The dhcpclass_id parameter is the DHCP acl identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpsubclass_value
DHCP acl data value.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

487
 DHCPv4 ACL and ACL Entries

Name
dhcp_subclass_options_list — List the DHCP options set on a DHCP ACL entry
Description
The service dhcp_subclass_options_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
dhcpsubclass_id
The dhcpsubclass_id parameter is the DHCP acl data identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

488
Chapter 40. DHCPv4 Failover

489
 DHCPv4 Failover

Name
dhcp_failover_add — Add/Edit a DHCPv4 failover channel
Description
The service dhcp_failover_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
ip_id
The DHCP server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
dhcp_ip_id
The dhcp_ip_id parameter is the DHCP server address identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP failover identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
failover_id
The failover_id parameter is the DHCP failover identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcpfailover_name
DHCP failover name.
failover_name
DHCP failover name.
dhcpfailover_type
DHCP failover type.
failover_type
DHCP failover type.
dhcpfailover_port
DHCP failover port.

490
 DHCPv4 Failover

failover_port
DHCP failover port.
dhcpfailover_peer_port
DHCP failover peer port.
failover_peer_port
DHCP failover peer port.
dhcpfailover_addr
DHCP failover IP address.
failover_addr
DHCP failover addr.
dhcpfailover_peer_addr
DHCP failover peer IP address.
failover_peer_addr
DHCP failover peer IP address.
peer_dhcp_id
The peer_dhcp_id parameter is the DHCP failover peer identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

491
 DHCPv4 Failover

Name
dhcp_failover_count — Number of DHCPv4 failover channels
Description
The service dhcp_failover_count allows to display the number of DHCPv4 failover channels.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpfailover_id, dhcp_name, dhcp_id, dhcp_type, vd-
hcp_parent_id, dhcpfailover_name, dhcpfailover_addr, dhcpfailover_port, peer_dhcp_id,
dhcpfailover_peer_addr, dhcpfailover_peer_port, dhcpfailover_state, dhcpfailover_type,
delayed_create_time, delayed_delete_time, ip_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

492
 DHCPv4 Failover

Name
dhcp_failover_list — List the DHCPv4 failovers
Description
The service dhcp_failover_list allows to list the DHCPv4 failovers one server at a time. Each
failover is listed with one server, no matter its role in the failover channels: one failover can be
listed one or several times depending on your configurations.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpfailover_id, dhcp_name, dhcp_id, dhcp_type, vd-
hcp_parent_id, dhcpfailover_name, dhcpfailover_addr, dhcpfailover_port, peer_dhcp_id,
dhcpfailover_peer_addr, dhcpfailover_peer_port, dhcpfailover_state, dhcpfailover_type,
delayed_create_time, delayed_delete_time, ip_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

493
 DHCPv4 Failover

dhcp_name
DHCP server name.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpfailover_name
DHCP group name.
dhcpfailover_addr
DHCP failover IP address.
dhcpfailover_port
DHCP failover port.
peer_dhcp_id
The peer_dhcp_id parameter is the DHCP failover peer identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpfailover_peer_addr
DHCP failover peer IP address.
dhcpfailover_peer_port
DHCP failover peer port.
dhcpfailover_state
Not documented.
dhcpfailover_type
DHCP failover type.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
ip_addr
IP address.

494
 DHCPv4 Failover

Name
dhcp_failover_server_list — List the DHCPv4 failover channels
Description
The service dhcp_failover_server_list allows to list the DHCPv4 failover channels. Each failover
channel is listed with the servers for which it was created. Each line returned contains the failover
servers, their role in the failover channel and any relevant data (DHCP server name, IP address...).

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.

495
 DHCPv4 Failover

Name
dhcp_failover_info — Display the properties of a DHCPv4 failover channel
Description
The service dhcp_failover_info returns the information on the object specified in input.

Input Parameters
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp_name
DHCP server name.
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_type
DHCP server type.
vdhcp_parent_id
Not documented.
dhcpfailover_name
DHCP group name.
dhcpfailover_addr
DHCP failover IP address.
dhcpfailover_port
DHCP failover port.
peer_dhcp_id
The peer_dhcp_id parameter is the DHCP failover peer identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
dhcpfailover_peer_addr
DHCP failover peer IP address.
dhcpfailover_peer_port
DHCP failover peer port.
dhcpfailover_state
Not documented.
dhcpfailover_type
DHCP failover type.

496
 DHCPv4 Failover

delayed_create_time
Not documented.
delayed_delete_time
Not documented.
ip_addr
IP address.

497
 DHCPv4 Failover

Name
dhcp_failover_set_partner_down — Set a DHCPv4 failover channel to PARTNER-
DOWN

Description
The service dhcp_failover_set_partner_down allows to set a DHCPv4 failover channel to partner-
down. To execute this service, users must be granted permission to use it.

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP failover identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpfailover_name
DHCP failover name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

498
 DHCPv4 Failover

Name
dhcp_failover_delete — Delete a DHCPv4 failover channel
Description
The service dhcp_failover_delete allows to delete SOLIDserver database object. The service
dhcp_failover_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
dhcp_id
The DHCPv4 server identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
dhcp_name
DHCP server name.
hostaddr
DHCP server address.
dhcp_addr
DHCP server address.
dhcpfailover_id
The dhcpfailover_id parameter is the DHCP group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
failover_id
The failover_id parameter is the DHCP group identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dhcpfailover_name
DHCP group name.
failover_name
DHCP group name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

499
Chapter 41. DHCPv6 Failover

500
 DHCPv6 Failover

Name
dhcp6_failover6_add — Add/Edit a DHCPv6 failover channel
Description
The service dhcp6_failover6_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
ip6_id
The ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcp6_ip6_id
The dhcp6_ip6_id parameter is the DHCPv6 server address identifier (ID). This identifier is
a unique numeric key value that is automatically incremented.
dhcpfailover6_id
The dhcpfailover6_id parameter is the DHCPv6 failover identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
failover6_id
The failover6_id parameter is the DHCPv6 failover identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
dhcpfailover6_name
DHCPv6 failover name.
failover6_name
DHCPv6 failover name.
dhcpfailover6_type
DHCPv6 failover type.
failover6_type
DHCPv6 failover type.
dhcpfailover6_port
DHCPv6 failover port.

501
 DHCPv6 Failover

failover6_port
DHCPv6 failover port.
dhcpfailover6_peer_port
DHCPv6 failover peer port.
failover6_peer_port
DHCPv6 failover peer port.
dhcpfailover6_addr
DHCPv6 failover IP address.
failover6_addr
DHCPv6 failover addr.
dhcpfailover6_peer_addr
DHCPv6 failover peer IP address.
failover6_peer_addr
DHCPv6 failover peer IP address.
peer_dhcp6_id
The peer_dhcp6_id parameter is the DHCPv6 failover peer identifier (ID). This identifier is a
unique numeric key value that is automatically incremented.
norefresh_server
internal use.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
check
Run check-rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

502
 DHCPv6 Failover

Name
dhcp6_failover6_count — Number of DHCPv6 failover channels
Description
The service dhcp6_failover6_count allows to display the number of DHCPv6 failover channels.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpfailover6_id, dhcp6_name, dhcp6_id, dhcp6_type,

vdhcp6_parent_id, dhcpfailover6_name, dhcpfailover6_addr, dhcpfailover6_port, peer_dh-
cp6_id, dhcpfailover6_peer_addr, dhcpfailover6_peer_port, dhcpfailover6_state, dhcpfail-
over6_type, delayed_time, ip6_addr.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

503
 DHCPv6 Failover

Name
dhcp6_failover6_list — List the DHCPv6 failover channels
Description
The service dhcp6_failover6_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dhcpfailover6_id, dhcp6_name, dhcp6_id, dhcp6_type,

vdhcp6_parent_id, dhcpfailover6_name, dhcpfailover6_addr, dhcpfailover6_port, peer_dh-
cp6_id, dhcpfailover6_peer_addr, dhcpfailover6_peer_port, dhcpfailover6_state, dhcpfail-
over6_type, delayed_time, ip6_addr.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpfailover6_id
Not documented.
dhcp6_name
Not documented.
dhcp6_id
Not documented.

504
 DHCPv6 Failover

dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.
dhcpfailover6_name
Not documented.
dhcpfailover6_addr
Not documented.
dhcpfailover6_port
Not documented.
peer_dhcp6_id
Not documented.
dhcpfailover6_peer_addr
Not documented.
dhcpfailover6_peer_port
Not documented.
dhcpfailover6_state
Not documented.
dhcpfailover6_type
Not documented.
delayed_time
Not documented.
ip6_addr
IP6 address.

505
 DHCPv6 Failover

Name
dhcp6_failover6_server6_list — List the DHCPv6 failover channels
Description
The service dhcp6_failover6_server6_list allows to list entries from SOLIDserver database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

506
 DHCPv6 Failover

Name
dhcp6_failover6_info — Display the properties of a DHCPv6 failover channel
Description
The service dhcp6_failover6_info returns the information on the object specified in input.

Input Parameters
dhcpfailover6_id
Not documented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dhcpfailover6_id
Not documented.
dhcp6_name
Not documented.
dhcp6_id
Not documented.
dhcp6_type
Not documented.
vdhcp6_parent_id
Not documented.
dhcpfailover6_name
Not documented.
dhcpfailover6_addr
Not documented.
dhcpfailover6_port
Not documented.
peer_dhcp6_id
Not documented.
dhcpfailover6_peer_addr
Not documented.
dhcpfailover6_peer_port
Not documented.
dhcpfailover6_state
Not documented.
dhcpfailover6_type
Not documented.
delayed_time
Not documented.
ip6_addr
IP6 address.

507
 DHCPv6 Failover

Name
dhcp6_failover6_delete — Delete a DHCPv6 failover channel
Description
The service dhcp6_failover6_delete allows to delete SOLIDserver database object. The service
dhcp6_failover6_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
dhcp6_id
The dhcp6_id parameter is the DHCPv6 server identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcp6_name
DHCPv6 server name.
hostaddr
DHCPv6 server address.
dhcp6_addr
DHCPv6 server address.
dhcpfailover6_id
The dhcpfailover6_id parameter is the DHCPv6 group identifier (ID). This identifier is a unique
numeric key value that is automatically incremented.
failover6_id
The failover6_id parameter is the DHCP group identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dhcpfailover6_name
DHCPv6 group name.
failover6_name
DHCPv6 group name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

508
Part V. DNS Services
Table of Contents
42. DNS Server ............................................................................................................. 512
dns_add ............................................................................................................... 513
dns_server_count .................................................................................................. 516
dns_server_list ...................................................................................................... 517
dns_server_info .................................................................................................... 521
dns_options_add ................................................................................................... 524
dns_server_param_add ......................................................................................... 526
dns_server_param_count ...................................................................................... 527
dns_server_param_list .......................................................................................... 528
dns_server_param_info ......................................................................................... 530
dns_server_param_delete ..................................................................................... 531
dns_send_rndc ..................................................................................................... 532
group_dns_add ..................................................................................................... 533
group_dns_delete ................................................................................................. 534
dns_server_admin_group_count ............................................................................ 535
dns_server_admin_group_list ................................................................................ 536
dns_server_admin_service_count .......................................................................... 538
dns_server_admin_service_list .............................................................................. 539
dns_delete ............................................................................................................ 540
43. DNS ACL ................................................................................................................ 541
dns_acl_add ......................................................................................................... 542
dns_acl_count ....................................................................................................... 543
dns_acl_list ........................................................................................................... 544
dns_acl_info ......................................................................................................... 546
dns_acl_delete ...................................................................................................... 547
44. TSIG Key ................................................................................................................. 548
dns_key_add ........................................................................................................ 549
dns_key_count ...................................................................................................... 551
dns_key_list .......................................................................................................... 552
dns_key_info ......................................................................................................... 554
dns_key_delete ..................................................................................................... 555
45. View ........................................................................................................................ 556
dns_view_add ....................................................................................................... 557
dns_view_count .................................................................................................... 559
dns_view_list ........................................................................................................ 560
dns_view_info ....................................................................................................... 562
dns_view_param_add ............................................................................................ 564
dns_view_param_count ......................................................................................... 565
dns_view_param_list ............................................................................................. 566
dns_view_param_info ............................................................................................ 568
dns_view_param_delete ........................................................................................ 569
dns_view_admin_group_count ............................................................................... 570
dns_view_admin_group_list ................................................................................... 571
dns_view_admin_service_count ............................................................................. 573
dns_view_admin_service_list ................................................................................. 574
group_dnsview_add .............................................................................................. 575
group_dnsview_delete ........................................................................................... 576
dns_view_delete ................................................................................................... 577
46. Zone ....................................................................................................................... 578
dns_zone_add ...................................................................................................... 579
dns_zone_count .................................................................................................... 581

510
 DNS Services

dns_zone_list ........................................................................................................ 582

dns_zone_info ....................................................................................................... 586
dns_zone_param_add ........................................................................................... 590
dns_zone_param_count ........................................................................................ 591
dns_zone_param_list ............................................................................................ 592
dns_zone_param_info ........................................................................................... 594
dns_zone_param_delete ....................................................................................... 595
dns_zone_admin_group_count .............................................................................. 596
dns_zone_admin_group_list .................................................................................. 597
dns_zone_admin_service_count ............................................................................ 599
dns_zone_admin_service_list ................................................................................ 600
group_dnszone_add .............................................................................................. 601
group_dnszone_delete .......................................................................................... 602
dns_zone_delete ................................................................................................... 603
47. Resource Record ..................................................................................................... 604
dns_rr_add ........................................................................................................... 605
dns_rr_count ......................................................................................................... 608
dns_rr_info ............................................................................................................ 609
dns_rr_list ............................................................................................................. 611
dns_rr_delete ........................................................................................................ 614
48. DNSSEC ................................................................................................................. 616
macro_sign_dnssec_zones_php ............................................................................ 617
dnssec_link_anchor ............................................................................................... 619
dnssec_trust_anchor_count ................................................................................... 620
dnssec_trust_anchor_list ....................................................................................... 621
dnssec_trust_anchor_info ...................................................................................... 623
dnssec_unlink_anchor ........................................................................................... 625

511
Chapter 42. DNS Server

512
 DNS Server

Name
dns_add — Add/Edit a DNS server
Description
The service dns_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
dns_type
DNS server type.
hostaddr
The DNS server IP address.
dns_comment
Comments.
dns_class_name
The dns_class_name is the name of the file class that will used for this object. The name of
dns_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a dns_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
dns_class_parameters
The dns_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dns_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dns_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
vdns_list
VDNS ID list.
additional_parameters
Additional parameters passed to rules.

513
 DNS Server

zone
Zone name (for other DNS server).
snmp_port
SNMP port (IPM DNS).
snmp_profile_id
SNMP profile ID (IPM DNS).
snmp_retry
SNMP retry (IPM DNS).
snmp_timeout
SNMP timeout (IPM DNS).
snmp_use_tcp
SNMP use TCP (IPM DNS).
ipmdns_protocol
IPM DNS protocol.
ipmdns_https_login
IPM DNS https login.
ipmdns_https_password
IPM DNS https password.
ad_domain
AD domain (MS).
ad_user
AD user (MS).
ad_password
AD password (MS).
ans_key
ANS key (ANS).
vdns_arch
VDNS architecture (VDNS).
vdns_ref1_dns_id
VDNS ref1 DNS ID (VDNS).
vdns_ref2_dns_id
VDNS ref2 DNS ID (VDNS).
tsig_key_name
TSIG key name.
tsig_key_value
TSIG key value.
tsig_key_proto
TSIG key proto.
windns_use_ssl
Use SSL (WINDNS).
windns_port
TCP port (WINDNS).
windns_protocol
Protocol (WINDNS).

514
 DNS Server

windns_login
Login (WINDNS).
windns_password
Password (WINDNS).

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

515
 DNS Server

Name
dns_server_count — Number of DNS servers
Description
The service dns_server_count allows to display the number of DNS servers. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: modif_count, ipmdns_https_login, ipmdns_https_pass-

word, ipmdns_protocol, tree_path, isolated, windns_port, windns_use_ssl, windns_protocol,
dns_notify, dns_also_notify, dns_allow_query_cache, dns_allow_query, dns_allow_transfer,
dns_allow_recursion, dns_recursion, dns_forwarders, dns_forward, snmp_id, ldap_user,
ldap_password, ldap_domain, ref1_dns_name, vdns_ref1_dns_id, ref2_dns_name,
vdns_ref2_dns_id, tree_level, total_vdns_members, vdns_members_name, vdns_arch,
vdns_parent_name, vdns_parent_arch, vdns_parent_id, vdns_ref1_dns_name,
vdns_ref2_dns_name, dns_id, site_id, site_name, dns_state, dns_synching, dns_name,
dns_comment, dns_type, row_enabled, ip_addr, dns_custom1, dns_custom2, dns_custom3,
dns_class_name, dns_class_parameters, dns_version, dns_key_name, dns_key_value.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

516
 DNS Server

Name
dns_server_list — List the DNS servers
Description
The service dns_server_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: modif_count, ipmdns_https_login, ipmdns_https_pass-

word, ipmdns_protocol, tree_path, isolated, windns_port, windns_use_ssl, windns_protocol,
dns_notify, dns_also_notify, dns_allow_query_cache, dns_allow_query, dns_allow_transfer,
dns_allow_recursion, dns_recursion, dns_forwarders, dns_forward, snmp_id, ldap_user,
ldap_password, ldap_domain, ref1_dns_name, vdns_ref1_dns_id, ref2_dns_name,
vdns_ref2_dns_id, tree_level, total_vdns_members, vdns_members_name, vdns_arch,
vdns_parent_name, vdns_parent_arch, vdns_parent_id, vdns_ref1_dns_name,
vdns_ref2_dns_name, dns_id, site_id, site_name, dns_state, dns_synching, dns_name,
dns_comment, dns_type, row_enabled, ip_addr, dns_custom1, dns_custom2, dns_custom3,
dns_class_name, dns_class_parameters, dns_version, dns_key_name, dns_key_value.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

517
 DNS Server

modif_count
Not documented.
ipmdns_https_login
Setup the HTTPS/SSL login account to manage the remote DNS server. By default this ac-
count is set to the admin account.
ipmdns_https_password
Setup the HTTPS/SSL password account to manage the remote DNS server.
ipmdns_protocol
Defined the protocol used to manage the EfficientIP DNS servers including the SOLIDserver
appliances and the package versions.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
windns_port
Defines the TCP port used by the EfficientIP WinDNS agent to manage the Microsoft DNS
servers.
windns_use_ssl
Use SSL (WINDNS).
windns_protocol
Protocol (WINDNS).
dns_notify
dns notify.
dns_also_notify
dns also notify.
dns_allow_query_cache
dns allow query_cache.
dns_allow_query
dns allow query.
dns_allow_transfer
dns allow transfer.
dns_allow_recursion
dns allow recursion.
dns_recursion
dns recursion.
dns_forwarders
dns forwarders.
dns_forward
dns forward.
snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
ldap_user
AD user.
ldap_password
AD password.

518
 DNS Server

ldap_domain
AD domain.
ref1_dns_name
Not documented.
vdns_ref1_dns_id
VDNS ref1 DNS ID (VDNS).
ref2_dns_name
Not documented.
vdns_ref2_dns_id
VDNS ref2 DNS ID (VDNS).
tree_level
Depth of imbricated spaces.
total_vdns_members
Not documented.
vdns_members_name
Not documented.
vdns_arch
VDNS architecture (VDNS).
vdns_parent_name
Not documented.
vdns_parent_arch
Not documented.
vdns_parent_id
Not documented.
vdns_ref1_dns_name
Not documented.
vdns_ref2_dns_name
Not documented.
dns_id
The dns_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
site name.
dns_state
Not documented.
dns_synching
Not documented.
dns_name
The DNS server name.
dns_comment
Comments.

519
 DNS Server

dns_type
DNS server type.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
ip_addr
IP address.
dns_class_name
The dns_class_name is the name of the file class that will used for this object. The name of
dns_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a dns_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
dns_class_parameters
The dns_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dns_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dns_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
dns_version
Not documented.
dns_key_name
Not documented.
dns_key_value
Not documented.

520
 DNS Server

Name
dns_server_info — Properties of a DNS server
Description
The service dns_server_info returns the information on the object specified in input.

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
modif_count
Not documented.
ipmdns_https_login
IPM DNS https login.
ipmdns_https_password
IPM DNS https password.
ipmdns_protocol
IPM DNS protocol.
isolated
If the server is isolated (parameter set to 1), it does not apply the configured default behaviors.
windns_port
TCP port (WINDNS).
windns_use_ssl
Use SSL (WINDNS).
windns_protocol
Protocol (WINDNS).
dns_notify
dns notify.
dns_also_notify
dns also notify.
dns_allow_query_cache
dns allow query_cache.
dns_allow_query
dns allow query.
dns_allow_transfer
dns allow transfer.
dns_allow_recursion
dns allow recursion.

521
 DNS Server

dns_recursion
dns recursion.
dns_forwarders
dns forwarders.
dns_forward
dns forward.
snmp_id
The snmp_id parameter is the SNMP identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
ldap_user
AD user.
ldap_password
AD password.
ldap_domain
AD domain.
ref1_dns_name
Not documented.
vdns_ref1_dns_id
VDNS ref1 DNS ID (VDNS).
ref2_dns_name
Not documented.
vdns_ref2_dns_id
VDNS ref2 DNS ID (VDNS).
tree_level
Depth of imbricated spaces.
total_vdns_members
Not documented.
vdns_members_name
Not documented.
vdns_arch
VDNS architecture (VDNS).
vdns_parent_name
Not documented.
vdns_parent_arch
Not documented.
vdns_parent_id
Not documented.
vdns_ref1_dns_name
Not documented.
vdns_ref2_dns_name
Not documented.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

522
 DNS Server

site_id
The site_id parameter is the Space identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
site_name
site name.
dns_state
Not documented.
dns_synching
Not documented.
dns_name
The DNS server name.
dns_comment
Comments.
dns_type
DNS server type.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
ip_addr
IP address.
dns_class_name
The dns_class_name is the name of the file class that will used for this object. The name of
dns_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a dns_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
dns_class_parameters
The dns_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dns_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by dns_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
dns_version
Not documented.
dns_key_name
Not documented.
dns_key_value
Not documented.

523
 DNS Server

Name
dns_options_add — Add/Edit DNS options on a server
Description
The service dns_options_add allows to add one or several DNS options to a DNS server. This
service has been replaced by the service dns_server_param_add.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
dns_addr
The DNS server IP address.
dns_forward
dns forward.
forward
dns forward.
dns_recursion
dns recursion.
recursion
dns recursion.
dns_notify
dns notify.
notify
dns notify.
dns_forwarders
dns forwarders.
forwarders
dns forwarders.
dns_allow_query
dns allow query.
allow_query
dns allow query.

524
 DNS Server

dns_allow_transfer
dns allow transfer.
allow_transfer
dns allow transfer.
dns_allow_query_cache
dns allow query_cache.
allow_query_cache
dns allow query_cache.
dns_allow_recursion
dns allow recursion.
allow_recursion
dns allow recursion.
dns_also_notify
dns also notify.
also_notify
dns also notify.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

525
 DNS Server

Name
dns_server_param_add — Add/Edit DNS options on a server
Description
The service dns_server_param_add allows to add DNS options to a server. The options must
be added one at a time on a specific server. This service replaces the service dns_options_add.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
param_key
The DNS option name.
param_value
The DNS option value.
is_array
Specifies if the DNS param is an array or not.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

526
 DNS Server

Name
dns_server_param_count — Number of DNS options of a server
Description
The service dns_server_param_count allows to display the number of DNS options configured
on a DNS server. To execute this service, users must be granted permission to use it. The rows
returned to the user running the service depend on the resources granted to the group they belong
to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: oid, dns_id, dns_name, param_key, param_value,
row_enabled, delayed_create_time, delayed_delete_time.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

527
 DNS Server

Name
dns_server_param_list — List the DNS options of a server
Description
The service dns_server_param_list allows to list the DNS options configured on a DNS server.
To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: oid, dns_id, dns_name, param_key, param_value,
row_enabled, delayed_create_time, delayed_delete_time.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
oid
SNMP OID.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.

528
 DNS Server

param_key
The DNS option name.
param_value
The DNS option value.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

529
 DNS Server

Name
dns_server_param_info — Properties of a DNS option set on a DNS server
Description
The service dns_server_param_info returns the information on the DNS options set on the
server specified in input.

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
oid
SNMP OID.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
param_key
The DNS option name.
param_value
The DNS option value.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

530
 DNS Server

Name
dns_server_param_delete — Delete DNS options from a server
Description
The service dns_server_param_delete allows to delete DNS options set on the specified server.
To execute this service, users must be granted the permission to use it.

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
param_key
The DNS option name.
param_id
ID of the parameter.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

531
 DNS Server

Name
dns_send_rndc — Send an rndc command to a DNS server
Description
The service dns_send_rndc allows to send an rndc command to a DNS server. This command
can apply to the server itself (for the querylog, to flush cache, etc.) or a specific zone (to force a
retransfer, notify or refresh).

To execute this service, users must be granted the permission to use it, provided that they are
granted access to the relevant resources.

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
rndc_command
The rndc command. It specifies the object it applies to (the server itself or one of its zones).

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

532
 DNS Server

Name
group_dns_add — Add a DNS server as group resource
Description
The service group_dns_add allows to add an object as resource for a group of users. You must
specify the group of users and the object that you set as resource. Once set as a resource, the
group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

533
 DNS Server

Name
group_dns_delete — Remove a DNS server from a group resources
Description
The service group_dns_delete allows to delete SOLIDserver database object. The service
group_dns_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

534
 DNS Server

Name
dns_server_admin_group_count — Total number of groups that can access the
DNS server list

Description
The service dns_server_admin_group_count allows to display the total number of groups of users
that can access the DNS server list. The rows returned to the user running the service are not
subject to the group resources, this service returns data as if the user running it belonged to the
admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

535
 DNS Server

Name
dns_server_admin_group_list — List the groups that can access the DNS server
list

Description
The service dns_server_admin_group_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

536
 DNS Server

grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

537
 DNS Server

Name
dns_server_admin_service_count — Total number of rights for a group to
add/delete objects in a DNS server

Description
The service dns_server_admin_service_count allows to display the total number of rights for a
group of users to add/delete objects in a DNS server. The rows returned to the user running the
service are not subject to the group resources, this service returns data as if the user running it
belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

538
 DNS Server

Name
dns_server_admin_service_list — List the rights for a group to add/delete objects
in a DNS server

Description
The service dns_server_admin_service_list allows to list entries from SOLIDserver database.
The rows returned to the user running the service are not subject to the group resources, this
service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

539
 DNS Server

Name
dns_delete — Delete a DNS server
Description
The service dns_delete allows to delete SOLIDserver database object. The service dns_delete
needs to identify the object to delete with the input parameters detailed in the next section. This
service will be executed if the connected user running this service is allowed to delete the con-
cerned object

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
dns_addr
The DNS server IP address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

540
Chapter 43. DNS ACL

541
 DNS ACL

Name
dns_acl_add — Add/Edit a DNS ACL
Description
The service dns_acl_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
dns_addr
The DNS server IP address.
dnsacl_name
dns acl name.
acl_name
dns acl name.
dnsacl_value
dns acl value.
acl_value
dns acl value.
dnsacl_id
The dnsacl_id parameter is the dns acl identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

542
 DNS ACL

Name
dns_acl_count — Number of DNS ACLs
Description
The service dns_acl_list allows to list the DNS ACL in the database. To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dnsacl_name, dnsacl_value, dnsacl_id, dns_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

543
 DNS ACL

Name
dns_acl_list — List the DNS ACLs
Description
The service dns_acl_list allows to list the DNS ACLs in the database. To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dnsacl_name, dnsacl_value, dnsacl_id, dns_id.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dnsacl_name
dns acl name.
dnsacl_value
dns acl value.
dnsacl_id
The dnsacl_id parameter is the dns acl identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

544
 DNS ACL

dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

545
 DNS ACL

Name
dns_acl_info — Properties of a DNS ACL
Description
The service dns_acl_info returns the information on the ACL specified in input.

Input Parameters
dnsacl_id
The dnsacl_id parameter is the dns acl identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dnsacl_name
dns acl name.
dnsacl_value
dns acl value.
dnsacl_id
The dnsacl_id parameter is the dns acl identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.

546
 DNS ACL

Name
dns_acl_delete — Delete a DNS ACL
Description
The service dns_acl_delete allows to delete SOLIDserver database object. The service
dns_acl_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
ip_id
The DNS server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
site_name
DNS IP space name.
site_id
DNS IP space OID.
dnsacl_id
DNS acl OID.
dnsacl_name
DNS acl name.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

547
Chapter 44. TSIG Key

548
 TSIG Key

Name
dns_key_add — Add/Edit a TSIG key
Description
The service dns_key_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
dns_addr
The DNS server IP address.
dnskey_name
DNS TSIG key name.
dnskey_proto
DNS TSIG key proto.
dnskey_value
DNS TSIG key value.
dnsview_name
The DNS view name.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
dnskey_id
The dnskey_id parameter is the DNS TSIG key identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

549
 TSIG Key

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

550
 TSIG Key

Name
dns_key_count — Number of TSIG keys
Description
The service dns_key_count allows to display the number of DNS TSIG keys of the database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dns_id, dns_name, dns_type, vdns_parent_id, dnskey_id,
dnskey_name, dnskey_value, dnskey_proto, dnsview_name, dnsview_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

551
 TSIG Key

Name
dns_key_list — List the DNS keys
Description
The service dns_key_list allows to list the DNS keys of the database. To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dns_id, dns_name, dns_type, vdns_parent_id, dnskey_id,
dnskey_name, dnskey_value, dnskey_proto, dnsview_name, dnsview_id.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
dns_type
DNS server type.

552
 TSIG Key

vdns_parent_id
Not documented.
dnskey_id
The dnskey_id parameter is the DNS TSIG key identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dnskey_name
DNS TSIG key name.
dnskey_value
DNS TSIG key value.
dnskey_proto
DNS TSIG key proto.
dnsview_name
The DNS view name.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

553
 TSIG Key

Name
dns_key_info — Properties of a TSIG key
Description
The service dns_key_info returns the information on the DNs key specified in input.

Input Parameters
dnskey_id
The dnskey_id parameter is the DNS TSIG key identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
dns_type
DNS server type.
vdns_parent_id
Not documented.
dnskey_id
The dnskey_id parameter is the DNS TSIG key identifier (ID). This identifier is a unique nu-
meric key value that is automatically incremented.
dnskey_name
DNS TSIG key name.
dnskey_value
DNS TSIG key value.
dnskey_proto
DNS TSIG key proto.
dnsview_name
The DNS view name.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

554
 TSIG Key

Name
dns_key_delete — Delete a TSIG key
Description
The service dns_key_delete allows to delete the DNS TSIG key specified in input. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to.

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
ip_id
The DNS server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
site_name
DNS IP space name.
site_id
DNS IP space OID.
dnskey_id
DNS TSIG key OID.
dnskey_name
DNS TSIG key name.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

555
Chapter 45. View

556
 View

Name
dns_view_add — Add/Edit a view
Description
The service dns_view_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
dns_addr
The DNS server IP address.
dnsview_name
The DNS view name.
dnsview_match_clients
The DNS view match clients configuration.
dnsview_match_to
The DNS view match destinations configuration.
dnsview_allow_transfer
The DNS view allow transfer configuration.
dnsview_allow_query
The DNS view allow query configuration.
dnsview_allow_recursion
The DNS view allow recursion configuration.
dnsview_recursion
The DNS view recursion configuration.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

557
 View

no_calc_match_client
Do not execute calculation of match_client.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

558
 View

Name
dns_view_count — Number of views
Description
The service dns_view_count allows to display the number of views in the database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dnsview_recursion, dnsview_allow_recursion, dns-

view_allow_query, dnsview_allow_transfer, dnsview_key_name, dns_id, dns_type, dns_name,
vdns_parent_id, dnsview_name, dnsview_match_clients, dnsview_match_to, dnsview_id,
delayed_create_time, delayed_delete_time, dns_class_name, dns_comment, dns_version,
vdns_parent_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

559
 View

Name
dns_view_list — List the views
Description
The service dns_view_list allows to list the views of the database. To execute this service, users
must be granted permission to use it. The rows returned to the user running the service depend
on the resources granted to the group they belong to. The WHERE input parameter allows to
filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dnsview_recursion, dnsview_allow_recursion, dns-

view_allow_query, dnsview_allow_transfer, dnsview_key_name, dns_id, dns_type, dns_name,
vdns_parent_id, dnsview_name, dnsview_match_clients, dnsview_match_to, dnsview_id,
delayed_create_time, delayed_delete_time, dns_class_name, dns_comment, dns_version,
vdns_parent_name.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dnsview_recursion
The DNS view recursion configuration.
dnsview_allow_recursion
The DNS view allow recursion configuration.

560
 View

dnsview_allow_query
The DNS view allow query configuration.
dnsview_allow_transfer
The DNS view allow transfer configuration.
dnsview_key_name
Not documented.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_type
DNS server type.
dns_name
The DNS server name.
vdns_parent_id
Not documented.
dnsview_name
The DNS view name.
dnsview_match_clients
The DNS view match clients configuration.
dnsview_match_to
The DNS view match destinations configuration.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dns_class_name
The dns_class_name is the name of the file class that will used for this object. The name of
dns_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a dns_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
dns_comment
Comments.
dns_version
Not documented.
vdns_parent_name
Not documented.

561
 View

Name
dns_view_info — Properties of a view
Description
The service dns_view_info returns the information on the view specified in input.

Input Parameters
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dnsview_recursion
The DNS view recursion configuration.
dnsview_allow_recursion
The DNS view allow recursion configuration.
dnsview_allow_query
The DNS view allow query configuration.
dnsview_allow_transfer
The DNS view allow transfer configuration.
dnsview_key_name
Not documented.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_type
DNS server type.
dns_name
The DNS server name.
vdns_parent_id
Not documented.
dnsview_name
The DNS view name.
dnsview_match_clients
The DNS view match clients configuration.
dnsview_match_to
The DNS view match destinations configuration.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

562
 View

delayed_create_time
Not documented.
delayed_delete_time
Not documented.
dns_class_name
The dns_class_name is the name of the file class that will used for this object. The name of
dns_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a dns_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
dns_comment
Comments.
dns_version
Not documented.
vdns_parent_name
Not documented.

563
 View

Name
dns_view_param_add — Add/Edit DNS options on a view
Description
The service dns_view_param_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

564
 View

Name
dns_view_param_count — Number of DNS options of a view
Description
The service dns_view_param_count allows to display the number of DNS options configured on
a DNS view.To execute this service, users must be granted permission to use it.The rows returned
to the user running the service depend on the resources granted to the group they belong to.
The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: oid, dnsview_id, dns_name, dnsview_name, dns_id,
param_key, param_value, row_enabled, delayed_create_time, delayed_delete_time.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

565
 View

Name
dns_view_param_list — List the DNS options of a view
Description
The service dns_view_param_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: oid, dnsview_id, dns_name, dnsview_name, dns_id,
param_key, param_value, row_enabled, delayed_create_time, delayed_delete_time.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
oid
SNMP OID.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
dns_name
The DNS server name.

566
 View

dnsview_name
The DNS view name.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
param_key
The DNS option name.
param_value
The DNS option value.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

567
 View

Name
dns_view_param_info — Properties of a DNS option set on a view
Description
The service dns_view_param_info returns the information on the DNS options set on the view
specified in input.

Input Parameters
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
oid
SNMP OID.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
dns_name
The DNS server name.
dnsview_name
The DNS view name.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
param_key
The DNS option name.
param_value
The DNS option value.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

568
 View

Name
dns_view_param_delete — Delete DNS options from a view
Description
The service dns_view_param_delete allows to delete DNS options set on the specified view. To
execute this service, users must be granted the permission to use it.

Input Parameters
Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

569
 View

Name
dns_view_admin_group_count — Total number of groups that can access the
DNS view list

Description
The service dns_view_admin_group_count allows to display the total number of groups of users
that can access the DNS view list. The rows returned to the user running the service are not
subject to the group resources, this service returns data as if the user running it belonged to the
admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

570
 View

Name
dns_view_admin_group_list — List the groups that can access the DNS view list
Description
The service dns_view_admin_group_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

571
 View

grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

572
 View

Name
dns_view_admin_service_count — Total number of rights for a group to
add/delete objects in a DNS view

Description
The service dns_view_admin_service_count allows to display the total number of rights for a
group of users to add/delete objects in a DNS view. The rows returned to the user running the
service are not subject to the group resources, this service returns data as if the user running it
belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

573
 View

Name
dns_view_admin_service_list — List the rights of a group to add/delete objects
in a DNS view

Description
The service dns_view_admin_service_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

574
 View

Name
group_dnsview_add — Add a view as group resource
Description
The service group_dnsview_add allows to add an object as resource for a group of users. You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

575
 View

Name
group_dnsview_delete — Remove a view from a group resources
Description
The service group_dnsview_delete allows to delete SOLIDserver database object. The service
group_dnsview_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dnsview_id
The view identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

576
 View

Name
dns_view_delete — Delete a view
Description
The service dns_view_delete allows to delete SOLIDserver database object. The service
dns_view_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
ip_id
The DNS server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
site_name
DNS IP space name.
site_id
DNS IP space OID.
dnsview_id
The DNS view OID.
dnsview_name
The DNS view name.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

577
Chapter 46. Zone

578
 Zone

Name
dns_zone_add — Add/Edit a zone
Description
The service dns_zone_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dns_id
The dns_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dns_name
The DNS server name.
hostaddr
The DNS server IP address.
dnszone_site_id
The dnszone_site_id parameter is the DNS zone space identifier (ID) used to join foreign
data. This identifier is a unique numeric key value that is automatically incremented.
dnszone_site_name
Obsolete. This is an alias of dnszone_space_name.
dnszone_space_name
If you use the IPAM modules, this parameter specifies the space linked to space name.
dnsview_id
The dnsview_id parameter is the DNS view identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
dnsview_name
The DNS view name.
zone
Obsolete. This is an alias of dnszone_name.
dnszone_name
The DNS zone name.
zone_type
Obsolete. This is an alias of dnszone_type.
dnszone_type
Zone type can receive the following values: master, slave, forward, stub, hint, delegation-
only.

579
 Zone

master_addr
The IP address of the Master (for slave).
dnszone_class_name
The dnszone_class_name is the name of the file class that will used for this object. The name
of dnszone_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
dnszone_class_name parameter could be set to: my_favorite_dir/my_class.class.
dnszone_class_parameters
The dnszone_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dnszone_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dnszone_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
dnszone_ad_integrated
AD integrated (WINDNS only).
add_flag
This parameter specifies if the service call must send an error if the object already exists.
The allowed values are: new_edit will overwrite all existing objects or new_only will refuse
the service execution.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
additional_parameters
Additional parameters passed to rules.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

580
 Zone

Name
dns_zone_count — Number of zones
Description
The service dns_zone_count allows to display t he number of DNS zones in the database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: num_keys, ipmdns_protocol, dnszone_synching,

dns_state, vdns_parent_id, dnszone_allow_update, dnszone_allow_query, dnszone_al-
low_transfer, dnszone_forwarders, dnszone_forward, dnszone_notify, dnszone_also_notify,
dnszone_name_utf, dnszone_id, row_enabled, dns_type, dnszone_ad_integrated,
dnszone_sort_zone, dns_id, dns_name, dnszone_name, dnszone_rev_sort_zone,
dnszone_type, dnszone_masters, dnszone_xfer_done, dnszone_is_reverse, delayed_de-
lete_time, delayed_create_time, dnszone_site_name, dnszone_site_id, dnszone_custom1,
dnszone_custom2, dnszone_custom3, dnszone_class_name, dnszone_class_parameters,
dnsview_name, dnsview_id, dns_class_name, dns_comment, dns_version, vdns_par-
ent_name, ds.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

581
 Zone

Name
dns_zone_list — List the DNS options of a zone
Description
The service dns_zone_list allows to list the DNS zones of the database. To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: num_keys, ipmdns_protocol, dnszone_synching,

dns_state, vdns_parent_id, dnszone_allow_update, dnszone_allow_query, dnszone_al-
low_transfer, dnszone_forwarders, dnszone_forward, dnszone_notify, dnszone_also_notify,
dnszone_name_utf, dnszone_id, row_enabled, dns_type, dnszone_ad_integrated,
dnszone_sort_zone, dns_id, dns_name, dnszone_name, dnszone_rev_sort_zone,
dnszone_type, dnszone_masters, dnszone_xfer_done, dnszone_is_reverse, delayed_de-
lete_time, delayed_create_time, dnszone_site_name, dnszone_site_id, dnszone_class_name,
dnszone_class_parameters, dnsview_name, dnsview_id, dns_class_name, dns_comment,
dns_version, vdns_parent_name, ds.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
num_keys
Number of keys attached to the zone. This number of keys includes all ZSK and KSK.

582
 Zone

ipmdns_protocol
Define the protocol used for the management of the server. It can contain SSL or SNMP. By
default the SSL protocol is used.
dnszone_synching
Define if the zone is currently synchronizing. Value 1 indicates that the zone is synchronizing,
0 indicates that it is not.
dns_state
Define the last state of a zone. The values can be:
• ET: the server is in timeout.
• ER: the license key is invalid.
• IC: the credential to manage the server is invalid.
• ES: a syntax error has been find at the DNS configuration parsing.
• IS: an invalid setting as been found in the DNS configuration.
vdns_parent_id
Specifies the DNS identifier of the smart architecture. If the current server is belonging to a
smart architecture, then this value must contain an identifier. If the server is in stand alone
this parameter is empty.
dnszone_allow_update
Specifies which hosts are allowed to submit Dynamic DNS updates for master zones. The
default is to deny updates from all hosts. Note that allowing updates based on the IP address
of the requesting client is insecure and must be used with a TSIG key.
dnszone_allow_query
Specifies which hosts are allowed to ask ordinary DNS questions. allow-query may also be
specified at the server level, in which case it will be overridden by the zone setting. If not
specified, the default is to allow queries from all hosts.
dnszone_allow_transfer
Specifies which hosts are allowed to receive zone transfers from the server. If allow_transfer
is specified at the zone level, then it overrides the options allow-transfer at the server level.
If not specified, the default is to allow transfers to all hosts.
dnszone_forwarders
Specifies the IP addresses to be used for forwarding.The default is the empty list (no forward-
ing). Forwarding can also be configured on a per-domain basis, allowing for the global for-
warding options to be overridden in a variety of ways. You can set particular domains to use
different forwarders, or have a different forward only/first behavior, or not forward at all.
dnszone_forward
This option is only meaningful if the forwarders list is not empty. A value of first, the default,
causes the server to query the forwarders first — and if that doesn't answer the question,
the server will then look for the answer itself. If only is specified, the server will only query
the forwarders.
dnszone_notify
If yes (the default), DNS NOTIFY messages are sent when a zone the server is authoritative
for changes. The messages are sent to the servers listed in the zone NS records, and to any
servers listed in the also-notify option. If explicit, notifies are sent only to servers explicitly
listed using also-notify. If no, no notifies are sent. The notify option may also be specified in
the zone statement, in which case it overrides the options notify statement. It would only be
necessary to turn off this option if it caused slaves to crash. Within the Smart Architecture
the notify is automatically set to no on the slave zones.

583
 Zone

dnszone_also_notify
Defines a global list of IP addresses of name servers that are also sent NOTIFY messages
whenever a fresh copy of the zone is loaded, in addition to the servers listed in the zone NS
records. This helps to ensure that copies of the zones will quickly converge on stealth servers.
Optionally, a port may be specified with each also-notify address to send the notify messages
to a port other than the default of 53. If an also-notify list is given in a zone statement, it will
override the options also-notify statement. When a zone notify statement is set to no, the IP
addresses in the global also-notify list will not be sent NOTIFY messages for that zone. The
default is the empty list (no global notification list).
dnszone_name_utf
This parameter contains the domain name encoded in UTF8. UTF8 allows to manage DNS
punycode see RFC 3492.
dnszone_id
The dnszone_id parameter is the Zone identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
dns_type
DNS server type which specifies if the server is based on Microsoft, EfficientIP, BIND or
Nominum as well.
dnszone_ad_integrated
AD integrated (WINDNS only). The value is 1 for Active Directory and 0 for not
dnszone_sort_zone
This parameter can be used to apply a natural sort order.
dns_id
The dns_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dns_name
The DNS server name.
dnszone_name
Zone domain name.
dnszone_rev_sort_zone
This parameter can be used to apply a reverse natural sort order.
dnszone_type
Define the type of the zone. It can contain one of the following values: master, slave, stub,
forward, hint, delegation-only.
dnszone_masters
Defines a named masters list for inclusion in stub and slave zone masters clauses.
dnszone_xfer_done
Not documented.
dnszone_is_reverse
Define if the zone is a name zone type of a reverse zone type.

584
 Zone

delayed_delete_time
If the value is set to 1 then the zone is currently deleting. If the value is set to 0 the zone is
active
delayed_create_time
If the value is set to 1 then the zone is currently creating. If the value is set to 0 the zone is
active
dnszone_site_name
DNS zone space name.
dnszone_site_id
The dnszone_site_id parameter is the DNS zone space identifier (ID) used to join foreign
data. This identifier is a unique numeric key value that is automatically incremented.
dnszone_class_name
The dnszone_class_name is the name of the file class that will used for this object. The name
of dnszone_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
dnszone_class_name parameter could be set to: my_favorite_dir/my_class.class.
dnszone_class_parameters
The dnszone_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dnszone_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dnszone_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
dnsview_name
Name of the view.
dnsview_id
The dnsview_id parameter is the dns view identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dns_class_name
The dns_class_name is the name of the file class that will used for this object. The name of
dns_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a dns_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
dns_comment
Comments for the DNS server.
dns_version
Display the version of the DNS engine.
vdns_parent_name
Specifies the DNS name of the smart architecture. If the current server is belonging to a
smart architecture, then this value must contain a name. If the server is in stand alone this
parameter is empty.
ds
The ds parameter contains the DNSSEC delegation signer (DS) finger print key.

585
 Zone

Name
dns_zone_info — Properties of a zone
Description
The service dns_zone_info returns the information on the zone specified in input.

Input Parameters
dnszone_id
The dnszone_id parameter is the Zone identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
num_keys
Number of keys attached to the zone. This number of keys includes all ZSK and KSK.
ipmdns_protocol
Define the protocol used for the management of the server. It can contain SSL or SNMP. By
default the SSL protocol is used.
dnszone_synching
Define if the zone is currently synchronizing. Value 1 indicates that the zone is synchronizing,
0 indicates that it is not.
dns_state
Define the last state of a zone. The values can be:
• ET: the server is in timeout.
• ER: the license key is invalid.
• IC: the credential to manage the server is invalid.
• ES: a syntax error has been find at the DNS configuration parsing.
• IS: an invalid setting as been found in the DNS configuration.
vdns_parent_id
Specifies the DNS identifier of the smart architecture. If the current server is belonging to a
smart architecture, then this value must contain an identifier. If the server is in stand alone
this parameter is empty.
dnszone_allow_update
Specifies which hosts are allowed to submit Dynamic DNS updates for master zones. The
default is to deny updates from all hosts. Note that allowing updates based on the IP address
of the requesting client is insecure and must be used with a TSIG key.
dnszone_allow_query
Specifies which hosts are allowed to ask ordinary DNS questions. allow-query may also be
specified at the server level, in which case it will be overridden by the zone setting. If not
specified, the default is to allow queries from all hosts.

586
 Zone

dnszone_allow_transfer
Specifies which hosts are allowed to receive zone transfers from the server. If allow_transfer
is specified at the zone level, then it overrides the options allow-transfer at the server level.
If not specified, the default is to allow transfers to all hosts.
dnszone_forwarders
Specifies the IP addresses to be used for forwarding.The default is the empty list (no forward-
ing). Forwarding can also be configured on a per-domain basis, allowing for the global for-
warding options to be overridden in a variety of ways. You can set particular domains to use
different forwarders, or have a different forward only/first behavior, or not forward at all.
dnszone_forward
This option is only meaningful if the forwarders list is not empty. A value of first, the default,
causes the server to query the forwarders first — and if that doesn't answer the question,
the server will then look for the answer itself. If only is specified, the server will only query
the forwarders.
dnszone_notify
If yes (the default), DNS NOTIFY messages are sent when a zone the server is authoritative
for changes. The messages are sent to the servers listed in the zone NS records, and to any
servers listed in the also-notify option. If explicit, notifies are sent only to servers explicitly
listed using also-notify. If no, no notifies are sent. The notify option may also be specified in
the zone statement, in which case it overrides the options notify statement. It would only be
necessary to turn off this option if it caused slaves to crash. Within the Smart Architecture
the notify is automatically set to no on the slave zones.
dnszone_also_notify
Defines a global list of IP addresses of name servers that are also sent NOTIFY messages
whenever a fresh copy of the zone is loaded, in addition to the servers listed in the zone NS
records. This helps to ensure that copies of the zones will quickly converge on stealth servers.
Optionally, a port may be specified with each also-notify address to send the notify messages
to a port other than the default of 53. If an also-notify list is given in a zone statement, it will
override the options also-notify statement. When a zone notify statement is set to no, the IP
addresses in the global also-notify list will not be sent NOTIFY messages for that zone. The
default is the empty list (no global notification list).
dnszone_name_utf
This parameter contains the domain name encoded in UTF8. UTF8 allows to manage DNS
punycode see RFC 3492.
dnszone_id
The dnszone_id parameter is the Zone identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
dns_type
DNS server type which specifies if the server is based on Microsoft, EfficientIP, BIND or
Nominum as well.
dnszone_ad_integrated
AD integrated (WINDNS only). The value is 1 for Active Directory and 0 for not

587
 Zone

dnszone_sort_zone
This parameter can be used to apply a natural sort order.
dns_id
The dns_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dns_name
The DNS server name.
dnszone_name
Zone domain name.
dnszone_rev_sort_zone
This parameter can be used to apply a reverse natural sort order.
dnszone_type
Define the type of the zone. It can contain one of the following values: master, slave, stub,
forward, hint, delegation-only.
dnszone_masters
Defines a named masters list for inclusion in stub and slave zone masters clauses.
dnszone_xfer_done
Not documented.
dnszone_is_reverse
Define if the zone is a name zone type of a reverse zone type.
delayed_delete_time
If the value is set to 1 then the zone is currently deleting. If the value is set to 0 the zone is
active
delayed_create_time
If the value is set to 1 then the zone is currently creating. If the value is set to 0 the zone is
active
dnszone_site_name
DNS zone space name.
dnszone_site_id
The dnszone_site_id parameter is the DNS zone space identifier (ID) used to join foreign
data. This identifier is a unique numeric key value that is automatically incremented.
dnszone_class_name
The dnszone_class_name is the name of the file class that will used for this object. The name
of dnszone_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a
dnszone_class_name parameter could be set to: my_favorite_dir/my_class.class.
dnszone_class_parameters
The dnszone_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The dnszone_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by dnszone_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
dnsview_name
Name of the view.

588
 Zone

dnsview_id
The dnsview_id parameter is the dns view identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dns_class_name
The dns_class_name is the name of the file class that will used for this object. The name of
dns_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a dns_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
dns_comment
Comments for the DNS server.
dns_version
Display the version of the DNS engine.
vdns_parent_name
Not documented.
ds
The ds parameter contains the DNSSEC delegation signer (DS) finger print key.

589
 Zone

Name
dns_zone_param_add — Add/Edit DNS options on a zone
Description
The service dns_zone_param_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
dnszone_id
The dnszone_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
param_key
The DNS option name.
is_array
Specifies if the DNS param is an array or not.
param_value
The DNS option value.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

590
 Zone

Name
dns_zone_param_count — Number of DNS options of a zone
Description
The service dns_zone_param_count allows to display the number of DNS options configured on
a DNS view.To execute this service, users must be granted permission to use it.The rows returned
to the user running the service depend on the resources granted to the group they belong to.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: oid, dnszone_id, dns_name, dnszone_name, dns_id,
param_key, param_value, row_enabled, delayed_create_time, delayed_delete_time.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

591
 Zone

Name
dns_zone_param_list — List the DNS options of a zone
Description
The service dns_zone_param_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: oid, dnszone_id, dns_name, dnszone_name, dns_id,
param_key, param_value, row_enabled, delayed_create_time, delayed_delete_time.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
oid
SNMP OID.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
dns_name
The DNS server name.

592
 Zone

dnszone_name
The DNS zone name.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
param_key
The DNS option name.
param_value
The DNS option value.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

593
 Zone

Name
dns_zone_param_info — Properties of a DNS option set on a zone
Description
The service dns_zone_param_info returns the information on the DNS options set on the zone
specified in input.

Input Parameters
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
oid
SNMP OID.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
dns_name
The DNS server name.
dnszone_name
The DNS zone name.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
param_key
The DNS option name.
param_value
The DNS option value.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. If set to 2, the object is manageable and taken into account in the database
and configuration but the object content is not replicated. By default, row_enabled is set to
1 when an object is created.
delayed_create_time
Not documented.
delayed_delete_time
Not documented.

594
 Zone

Name
dns_zone_param_delete — Delete DNS options from a zone
Description
The service dns_zone_param_delete allows to delete DNS options set on the specified zone. To
execute this service, users must be granted the permission to use it.

Input Parameters
dnszone_id
The dnszone_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
param_key
The DNS option name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

595
 Zone

Name
dns_zone_admin_group_count — Total number of groups that can access the
DNS zone list

Description
The service dns_zone_admin_group_count allows to display the total number of groups of users
that can access the DNS zone list. The rows returned to the user running the service are not
subject to the group resources, this service returns data as if the user running it belonged to the
admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

596
 Zone

Name
dns_zone_admin_group_list — List the groups that can access the DNS zone list
Description
The service dns_zone_admin_group_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, grp_description, from_type.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

597
 Zone

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
grp_description
Group description.
from_type
Not documented.

598
 Zone

Name
dns_zone_admin_service_count — Total number of rights for a group to
add/delete objects in a zone

Description
The service dns_zone_admin_service_count allows to display the total number of rights for a
group of users to add/delete objects in a zone. The rows returned to the user running the service
are not subject to the group resources, this service returns data as if the user running it belonged
to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

599
 Zone

Name
dns_zone_admin_service_list — List the rights for a group to add/delete objects
in a zone

Description
The service dns_zone_admin_service_list allows to list entries from SOLIDserver database. The
rows returned to the user running the service are not subject to the group resources, this service
returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: service_name.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.

600
 Zone

Name
group_dnszone_add — Add a zone as group resource
Description
The service group_dnszone_add allows to add an object as resource for a group of users. You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use the service group_dnszone_add.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

601
 Zone

Name
group_dnszone_delete — Remove a zone from a group resources
Description
The service group_dnszone_delete allows to delete SOLIDserver database object. The service
group_dnszone_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

602
 Zone

Name
dns_zone_delete — Delete a zone
Description
The service dns_zone_delete allows to delete SOLIDserver database object. The
dns_zone_delete service needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
dns_id
The dns_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dns_name
Specifies the name of the DNS server. This name must be exactly the same one you defined
in the management interface.
hostaddr
Specifies the IP address of the DNS server as you defined in the management interface.
ip_id
The DNS server IP address identifier (ID). This identifier is a unique numeric key value that
is automatically incremented.
site_name
Defines the name of the space linked with the DNS server.
site_id
DNS IP space OID.
dnszone_id
DNS zone OID.
dnszone_name
DNS zone name.
zone
Obsolete. This is an alias of the dnszone_name.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

603
Chapter 47. Resource Record

604
 Resource Record

Name
dns_rr_add — Add/Edit a resource record
Description
The service dns_rr_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
rr_id
RR ID (for replacement).
dns_id
The dns_id parameter is the DNS identifier (ID) used to join foreign data. This identifier is a
unique numeric key value that is automatically incremented.
hostaddr
The DNS server IP address.
dns_name
The DNS server name.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
zone
DNS zone name (Obsolete. Has been replaced by dnszone_name).
dnszone_name
DNS zone name.
dnsview_id
The dnsview_id parameter is the DNS view identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dnsview_name
The DNS view name.
serial_type
SOA serial type.
rr_name
The rr_name specifies the domain name that must deleted. The fully qualified domain name
must be used for this parameter.
rr_ttl
RR TTL.
rr_type
RR type.
rr_value1
RR value 1.

605
 Resource Record

rr_value2
RR value 2.
rr_value3
RR value 3.
rr_value4
RR value 4.
rr_value5
RR value 5.
rr_value6
RR value 6.
rr_value7
RR value 7.
dnszone_site_id
The dnszone_site_id parameter is the DNS zone space identifier (ID) used to join foreign
data. This identifier is a unique numeric key value that is automatically incremented.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
force_update
Force DNS update.
check
Run check-rules.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
check_value
check on value flag.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

Example
Creating an A record and a CNAME record using a BASH script.
#!/bin/sh

# $1 = rr_name, $2 = rr_type, $3 = rr_value $4 = add / delete

user=ipmadmin
password=admin

dns_rr() {
curl -s -H "Content-Type: text/xml; charset=utf-8" \
-H "SOAPAction: \"urn:dns_rr_${4}\"" \
-d "<soapenv:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:urn=\\
"urn:IPM_SOAP\">
<soapenv:Header/>
<soapenv:Body>
<urn:dns_rr_${4} soapenv:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">
<input xsi:type=\"urn:dns_rr_${4}_in\" xmlns:urn=\"urn:IPM\">

606
 Resource Record

<auth_login xsi:type=\"xsd:string\">${user}</auth_login>
<auth_password xsi:type=\"xsd:string\">${password}</auth_password>
<dns_name xsi:type=\"xsd:string\">smart.test</dns_name>
<rr_name xsi:type=\"xsd:string\">${1}</rr_name>
<rr_type xsi:type=\"xsd:string\">${2}</rr_type>
<rr_value1 xsi:type=\"xsd:string\">${3}</rr_value1>
<dnszone_site_id xsi:type=\"xsd:string\">8</dnszone_site_id>
<force_update xsi:type=\"xsd:string\">1</force_update>
</input>
</urn:dns_rr_${4}>
</soapenv:Body>
</soapenv:Envelope>" \
--insecure -X POST https://10.0.249.64/interfaces/ws.php
}

dns_rr ${1} A 161.88.243.124 add

dns_rr www.${1} CNAME ${1} add

607
 Resource Record

Name
dns_rr_count — Number of resource records
Description
The service dns_rr_count allows to display the number of resources records in the database. To
execute this service, users must be granted permission to use it. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: rr_all_value, dnszone_sort_zone, dnszone_type,

rr_full_name, rr_full_name_utf, rr_name_ip_addr, rr_name_ip4_addr, rr_value_ip_addr,
rr_value_ip4_addr, rr_glue, rr_type, ttl, delayed_time, value1, value2, value3, value4, value5,
value6, value7, dnszone_id, rr_id, dns_id, dnszone_name_utf, dnszone_name, dns_name,
dns_type, vdns_parent_id, dnsview_name, dnsview_id, dnszone_site_name,
dnszone_is_reverse, dnszone_masters, vdns_parent_name, dnszone_forwarders,
dns_class_name, dnszone_class_name, dns_version, dns_comment, delayed_create_time.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

608
 Resource Record

Name
dns_rr_info — Properties of a resource record
Description
The service dns_rr_info returns the information on the resource record specified in input.

Input Parameters
rr_id
RR ID (for replacement).

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
rr_all_value
Not documented.
dnszone_sort_zone
This parameter can be used to apply a natural sort order.
dnszone_type
Zone type.
rr_full_name
Fully qualified domain name of a RR.
rr_full_name_utf
Fully qualified domain name of a RR encoded in UTF8
rr_name_ip_addr
See rr_name_ip4_addr.
rr_name_ip4_addr
If the RR name is an IP address, then it will contain the IP address encoded in hexadecimal.
rr_value_ip_addr
See rr_value_ip4_addr.
rr_value_ip4_addr
If the RR value1 is an IP address, then it will contain the IP address encoded in hexadecimal.
rr_glue
Short name of a RR.
rr_type
RR type.
ttl
RR TTL.
delayed_time
Not documented.
value1
RR value 1.
value2
RR value 2.

609
 Resource Record

value3
RR value 3.
value4
RR value 4.
value5
RR value 5.
value6
RR value 6.
value7
RR value 7.
dnszone_id
The dnszone_id parameter is the Zone identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
rr_id
RR ID (for replacement).
dns_id
The dns_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dnszone_name_utf
This parameter contains the domain name encoded in UTF8. UTF8 allows to manage DNS
punycode see RFC 3492.
dnszone_name
The DNS zone name.
dns_name
The DNS server name.
dns_type
DNS server type which specifies if the server is based on Microsoft, EfficientIP, BIND or
Nominum as well.
vdns_parent_id
Specifies the DNS identifier of the smart architecture. If the current server is belonging to a
smart architecture, then this value must contain an identifier. If the server is in stand alone
this parameter is empty.
dnsview_name
The DNS view name.
dnsview_id
The dnsview_id parameter is the dns view identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dnszone_site_name
DNS zone space name.
dnszone_is_reverse
Define if the zone is a name zone type of a reverse zone type.
delayed_create_time
If the value is set to 1 then the zone is currently creating. If the value is set to 0 the zone is
active

610
 Resource Record

Name
dns_rr_list — List the resource records
Description
The service dns_rr_list allows to list data from the SOLIDserver database. To execute this service,
users must be granted permission to use it. The rows returned to the user running the service
depend on the resources granted to the group they belong to. The WHERE input parameter allows
to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: rr_all_value, dnszone_sort_zone, dnszone_type,

rr_full_name, rr_full_name_utf, rr_name_ip_addr, rr_name_ip4_addr, rr_value_ip_addr,
rr_value_ip4_addr, rr_glue, rr_type, ttl, delayed_time, value1, value2, value3, value4, value5,
value6, value7, dnszone_id, rr_id, dns_id, dnszone_name_utf, dnszone_name, dns_name,
dns_type, vdns_parent_id, dnsview_name, dnsview_id, dnszone_site_name,
dnszone_is_reverse, dnszone_masters, vdns_parent_name, dnszone_forwarders,
dns_class_name, dnszone_class_name, dns_version, dns_comment, delayed_create_time.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
rr_all_value
Not documented.

611
 Resource Record

dnszone_sort_zone
This parameter can be used to apply a natural sort order.
dnszone_type
Zone type.
rr_full_name
Fully qualified domain name of a RR.
rr_full_name_utf
Fully qualified domain name of a RR encoded in UTF8
rr_name_ip_addr
See rr_name_ip4_addr.
rr_name_ip4_addr
If the RR name is an IP address, then it will contain the IP address encoded in hexadecimal.
rr_value_ip_addr
See rr_value_ip4_addr.
rr_value_ip4_addr
If the RR value1 is an IP address, then it will contain the IP address encoded in hexadecimal.
rr_glue
Short name of a RR.
rr_type
RR type.
ttl
RR TTL.
delayed_time
Not documented.
value1
RR value 1.
value2
RR value 2.
value3
RR value 3.
value4
RR value 4.
value5
RR value 5.
value6
RR value 6.
value7
RR value 7.
dnszone_id
The dnszone_id parameter is the Zone identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
rr_id
RR ID (for replacement).

612
 Resource Record

dns_id
The dns_id parameter is the DNS server identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dnszone_name_utf
This parameter contains the domain name encoded in UTF8. UTF8 allows to manage DNS
punycode see RFC 3492.
dnszone_name
The DNS zone name.
dns_name
The DNS server name.
dns_type
DNS server type which specifies if the server is based on Microsoft, EfficientIP, BIND or
Nominum as well.
vdns_parent_id
Specifies the DNS identifier of the smart architecture. If the current server is belonging to a
smart architecture, then this value must contain an identifier. If the server is in stand alone
this parameter is empty.
dnsview_name
The DNS view name.
dnsview_id
The dnsview_id parameter is the dns view identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dnszone_site_name
DNS zone space name.
dnszone_is_reverse
Define if the zone is a name zone type of a reverse zone type.
delayed_create_time
If the value is set to 1 then the zone is currently creating. If the value is set to 0 the zone is
active

613
 Resource Record

Name
dns_rr_delete — Delete a resource record
Description
The service dns_rr_delete allows to delete SOLIDserver database object. The dns_rr_delete
service needs to identify the object to delete with the input parameters detailed in the next section.
This service will be executed if the connected user running this service is allowed to delete the
concerned object

Input Parameters
rr_id
RR ID (for replacement).
dns_id
The dns_id parameter is the DNS identifier (ID) used to join foreign data. This identifier is a
unique numeric key value that is automatically incremented.
hostaddr
The DNS server IP address.
dns_name
The DNS server name.
dnszone_id
The zone identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
zone
DNS zone name (Obsolete. Has been replaced by dnszone_name).
dnszone_name
DNS zone name.
dnsview_id
The dnsview_id parameter is the DNS view identifier (ID). This identifier is a unique numeric
key value that is automatically incremented.
dnsview_name
The DNS view name.
rr_name
The rr_name specifies the domain name that must deleted. Different value formats must be
set to rr_name, according to other parameters context. If the zone is specified with
dnszone_name, dnszone_id or zone parameter, then the short RR name (label) must be
used. If the zone is not specified, then the fully qualified domain name must be used.
rr_ttl
RR TTL.
rr_type
RR type.
rr_value1
RR value 1.
rr_value2
RR value 2.

614
 Resource Record

rr_value3
RR value 3.
rr_value4
RR value 4.
rr_value5
RR value 5.
rr_value6
RR value 6.
rr_value7
RR value 7.
dnszone_site_id
The dnszone_site_id parameter is the DNS zone space identifier (ID) used to join foreign
data. This identifier is a unique numeric key value that is automatically incremented.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

615
Chapter 48. DNSSEC

616
 DNSSEC

Name
macro_sign_dnssec_zones_php — Sign a zones with DNSSEC
Description
The service macro_sign_dnssec_zones_php allows to sign DNS zones with DNSSEC.To execute
this service, users must be granted permission to use it, provided the group they belong has the
relevant resources.

Input Parameters
zsk_encryption
Defines the cryptographic algorithm for which the key is being generated and implicitly de-
termines both usage and the RR type (KEY or DNSKEY) generated. May take one of the
following case-insensitive values based on required usage: TSIG/TKEY: DH, HMAC-MD5,
HMAC-SHA1, HMAC-SHA224, HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512.
zsk_encryption_bits
Specifies the number of bits to be used in the key and depends on the algorithm being used:
RSAMD5, RSASHA1, RSASHA256, and NSEC3. RSASHA1 range is 512 - 4096 (current
RSA recommendation is 1024 but this changes over time); RSASHA512 range is 1024- 4096
(current RSA recommendation is 1024 but this changes over time); DSA range is 512-1024
(must be a multiple of 64); DH range is 128-4096; HMAC-MD5 range is 1-512; HMAC-SHA1
range is 1-160; HMACSHA224 range is 1-224; HMAC-SHA256 range is 1-256; HMAC-
SHA384 range is 1- 384; HMAC-SHA512 range is 1-512.
zsk_validity
Defines the time validity of the generate ZSK key. The unit of this number is defined within
the zsk_validity_unit parameter. The maximum allowed value must not later than 31/12/2037.
zsk_validity_unit
Unit of the zsk_validity parameter. May take one of the following case-insensitive values
based on required usage: day, month, year, or infinity.
ksk_encryption
Defines the cryptographic algorithm for which the key is being generated and implicitly de-
termines both usage and the RR type (KEY or DNSKEY) generated. May take one of the
following case-insensitive values based on required usage: TSIG/TKEY: DH, HMAC-MD5,
HMAC-SHA1, HMAC-SHA224, HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512.
ksk_encryption_bits
Specifies the number of bits to be used in the key and depends on the algorithm being used:
RSAMD5, RSASHA1, RSASHA256, and NSEC3. RSASHA1 range is 512 - 4096 (current
RSA recommendation is 1024 but this changes over time); RSASHA512 range is 1024- 4096
(current RSA recommendation is 1024 but this changes over time); DSA range is 512-1024
(must be a multiple of 64); DH range is 128-4096; HMAC-MD5 range is 1-512; HMAC-SHA1
range is 1-160; HMACSHA224 range is 1-224; HMAC-SHA256 range is 1-256; HMAC-
SHA384 range is 1- 384; HMAC-SHA512 range is 1-512.
ksk_validity
Defines the time validity of the generate ZSK key. The unit of this number is defined within
the ksk_validity_unit parameter. The maximum allowed value must not greater than
31/12/2037.
ksk_validity_unit
Unit of the ksk_validity parameter. May take one of the following case-insensitive values
based on required usage: day, month, year, or infinity.

617
 DNSSEC

selected_query
Contains a service to select the zones to sign. This parameter must call the service
dns_zone_list to select the target zone(s) through their ID or name. To sign several zones
at once, use the condition in within the SQL query of the clause WHERE.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

Example
Signing a zone with DNSSEC using a PHP script to execute the service via SOAP.
<?php

$context = stream_context_create(array(
'ssl' => array(
'verify_peer' => false,
'verify_peer_name' => false,
'allow_self_signed' => true
)
));

$client = new SoapClient('https://solid.intranet/interfaces/wsdl_eip_full.wsdl', array('stream_context'

=> $context));

// Try to sign the DNS zone

$struct = array('auth_login' => 'ipmadmin',
'auth_password' => 'admin',
'zsk_encryption_type' => 'rsasha512',
'zsk_encryption_bits' => '1024',
'zsk_validity' => '14', 'zsk_validity_unit' => 'day',
'ksk_encryption_type' => 'rsasha512', 'ksk_encryption_bits' => '1024',
'ksk_validity' => '14',
'ksk_validity_unit' => 'day',
'selected_query' => 'dns_zone_list WHERE='.urlencode('dnszone_id='.$dnszoneId));
$ret = $client->macro_sign_dnssec_zones_php($struct);

// Check that the calls succeeded

if (!empty($ret[0]->errno)) {
echo "Could not sign the DNS zones.\nErrno: {$ret[0]->errno}\nMessage: {$ret[0]->errmsg}\n";
if (!empty($ret[0]->param_value)) {
echo "Parameter: {$ret[0]->param_value}\n"; }
// The zone is already signed, thus this is not an issue
if ($ret[0]->errno != 53264)
exit(1);
}
if (empty($ret[0]->errno))
echo "Successfully signed the zone.\n";

618
 DNSSEC

Name
dnssec_link_anchor — Apply a DNSSEC trust anchor to a DNSSEC resolver
Description
The service dnssec_link_anchor allows to use a trust anchor on the DNS server specified in input,
this server must be a DNSSEC resolver.To execute this service, users must be granted permission
to use it.

Input Parameters
dns_id
The dns_id parameter is the DNS identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
dns_name
DNS name.
anchor_id
The anchor_id parameter is the Anchor identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

619
 DNSSEC

Name
dnssec_trust_anchor_count — Number of DNSSEC trust anchors
Description
The service dnssec_trust_anchor_count allows to display the number of trust anchors in the
database. To execute this service, users must be granted permission to use it. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dns_id, key_id, obj_type, encryption_data, encryp-
tion_bits, subject, validity, start_date, encryption_data_public, obj_name, ds, dlv,
dnszone_name, encryption_type.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

620
 DNSSEC

Name
dnssec_trust_anchor_list — List the DNSSEC trust anchors
Description
The service dnssec_trust_anchor_list allows to list trust anchors in the database. To execute this
service, users must be granted permission to use it. The WHERE input parameter allows to filter
the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: dns_id, key_id, obj_type, encryption_data, encryp-
tion_bits, subject, validity, start_date, encryption_data_public, obj_name, ds, dlv,
dnszone_name, encryption_type.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
key_id
ID of the key.
obj_type
Type of the key.

621
 DNSSEC

encryption_data
Not documented.
encryption_bits
Bit length.
subject
Not documented.
validity
Validity period (days).
start_date
Start date.
encryption_data_public
Not documented.
obj_name
Name of the key.
ds
DS Set.
dlv
DLV Set.
dnszone_name
The DNS zone name.
encryption_type
Encryption type.

622
 DNSSEC

Name
dnssec_trust_anchor_info — Properties of a DNSSEC trust anchor
Description
The service dnssec_trust_anchor_info returns the information on the trust anchor specified in
input. To execute this service, users must be granted permission to use it.

Input Parameters
anchor_id
The anchor_id parameter is the Anchor identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
dns_id
The DNS server identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
key_id
ID of the key.
obj_type
Type of the key.
encryption_data
Not documented.
encryption_bits
Bit length.
subject
Not documented.
validity
Validity period (days).
start_date
Start date.
encryption_data_public
Not documented.
obj_name
Name of the key.
ds
DS Set.
dlv
DLV Set.
dnszone_name
The DNS zone name.

623
 DNSSEC

encryption_type
Encryption type.

624
 DNSSEC

Name
dnssec_unlink_anchor — Stop using a DNSSEC trust anchor on a DNS server
Description
The service dnssec_link_anchor allows to stop using a trust anchor on the DNS server specified
in input. To execute this service, users must be granted permission to use it.

Input Parameters
dns_id
The dns_id parameter is the DNS identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
dns_name
DNS name.
anchor_id
The anchor_id parameter is the Anchor identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
link_id
The link_id parameter is the Link identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

625
Part VI. NetChange Services
Table of Contents
49. Network Device ....................................................................................................... 628
iplnetdev_count ..................................................................................................... 629
iplnetdev_list ......................................................................................................... 630
iplnetdev_info ........................................................................................................ 632
group_iplnetdev_add ............................................................................................. 634
group_iplnetdev_delete .......................................................................................... 635
iplocator_netdev_delete ......................................................................................... 636
50. VLAN ...................................................................................................................... 637
iplnetdevvlan_count ............................................................................................... 638
iplnetdevvlan_list ................................................................................................... 639
51. Port ......................................................................................................................... 641
iplocator_port_add ................................................................................................ 642
iplport_count ......................................................................................................... 643
iplport_list ............................................................................................................. 644
iplport_info ............................................................................................................ 646
52. Discovered Item ....................................................................................................... 648
ipldev_count ......................................................................................................... 649
ipldev_list .............................................................................................................. 650
ipldev_log_count ................................................................................................... 654
ipldev_log_list ....................................................................................................... 655

627
Chapter 49. Network Device

628
 Network Device

Name
iplnetdev_count — Number of network devices
Description
The service iplnetdev_count allows to list all the network devices managed via SOLIDserver. To
execute this service, users must be granted permission to use the service iplnetdev_count. The
rows returned to the user running the service depend on the resources granted to the group they
belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: site_name, ip_id, site_id, iplnetdev_ip_addr, iplnet-
dev_stack_id, iplnetdev_nb_stack, iplnetdev_name, iplnetdev_synching, iplnetdev_uptime,
iplnetdev_sysname, iplnetdev_syscontact, iplnetdev_type, iplnetdev_vendor, iplnetdev_descr,
iplnetdev_vlanid, iplnetdev_updatetime, iplnetdev_analysistime, iplnetdev_status, iplnet-
dev_nbports, iplnetdev_nbusedports, iplnetdev_sysoid, iplnetdev_shortdescr, iplnetdev_fin-
ished, iplnetdev_refresh_parameters, iplnetdev_refresh_rancid_parameters, iplnetdev_serial,
iplnetdev_slot_serial, iplnetdev_syslocation, iplnetdev_class_name, iplnetdev_class_para-
meters, snmp_id, iplnetdev_version, iplnetdev_id, iplnetdev_nbfreeports, iplnetdev_percused-
ports, iplnetdevip_ip_addr_list, supported_mibs, iplnetdev_dot1x, iplnetdev_port_security,
row_enabled.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

629
 Network Device

Name
iplnetdev_list — List the network devices
Description
The service iplnetdev_list allows to list the network devices managed via SOLIDserver. To execute
this service, users must be granted permission to use the service iplnetdev_list. The rows returned
to the user running the service depend on the resources granted to the group they belong to.
The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: site_name, ip_id, site_id, iplnetdev_ip_addr, iplnet-
dev_stack_id, iplnetdev_nb_stack, iplnetdev_name, iplnetdev_synching, iplnetdev_uptime,
iplnetdev_sysname, iplnetdev_syscontact, iplnetdev_type, iplnetdev_vendor, iplnetdev_descr,
iplnetdev_vlanid, iplnetdev_updatetime, iplnetdev_analysistime, iplnetdev_status, iplnet-
dev_nbports, iplnetdev_nbusedports, iplnetdev_sysoid, iplnetdev_shortdescr, iplnetdev_fin-
ished, iplnetdev_refresh_parameters, iplnetdev_refresh_rancid_parameters, iplnetdev_serial,
iplnetdev_slot_serial, iplnetdev_syslocation, iplnetdev_class_name, iplnetdev_class_para-
meters, snmp_id, iplnetdev_version, iplnetdev_id, iplnetdev_nbfreeports, iplnetdev_percused-
ports, iplnetdevip_ip_addr_list, supported_mibs, iplnetdev_dot1x, iplnetdev_port_security,
row_enabled.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

630
 Network Device

iplnetdev_ip_addr
The network device IP address.
ip_id
The network device IP address identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
iplnetdev_status
The network device status.
iplnetdev_syslocation
The network device location, as stored on the network device.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
iplnetdev_nbfreeports
The number of free ports on the network device.
iplnetdev_class_name
The name of the class applied to the network device. It must include the class file name and
the directory it belongs to, for instance, my_favorite_dir/my_class.class . The classes global
and default cannot be used. This parameter can be empty.
iplnetdev_class_parameters
The parameters of the class specified in the parameter [object]_class_name. The class can
contain several parameters, each parameter must have a maximum length of 4000 characters
and the value of each parameter must be set in the following URL style format:
metadata1=value1&metadata2=value2& . The URL value must be encoded in URL format
as defined in RFC 3986. This parameter can be empty.
snmp_id
The identifier (ID) of the SNMP configuration the network device belongs to in SOLIDserver
database. This identifier is a unique numeric key value that is automatically incremented.

631
 Network Device

Name
iplnetdev_info — Display the properties of a network device
Description
The service iplnetdev_info returns the information on the object specified in input. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: site_name, ip_id, site_id, iplnetdev_ip_addr, iplnet-
dev_stack_id, iplnetdev_nb_stack, iplnetdev_name, iplnetdev_synching, iplnetdev_uptime,
iplnetdev_sysname, iplnetdev_syscontact, iplnetdev_type, iplnetdev_vendor, iplnetdev_descr,
iplnetdev_vlanid, iplnetdev_updatetime, iplnetdev_analysistime, iplnetdev_status, iplnet-
dev_nbports, iplnetdev_nbusedports, iplnetdev_sysoid, iplnetdev_shortdescr, iplnetdev_fin-
ished, iplnetdev_refresh_parameters, iplnetdev_refresh_rancid_parameters, iplnetdev_serial,
iplnetdev_slot_serial, iplnetdev_syslocation, iplnetdev_class_name, iplnetdev_class_para-
meters, snmp_id, iplnetdev_version, iplnetdev_id, iplnetdev_nbfreeports, iplnetdev_percused-
ports, iplnetdevip_ip_addr_list, supported_mibs, iplnetdev_dot1x, iplnetdev_port_security,
row_enabled.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
iplnetdev_ip_addr
The network device IP address.
ip_id
The network device IP address identifier (ID). This identifier is a unique numeric key value
that is automatically incremented.
iplnetdev_status
The network device status.
iplnetdev_syslocation
The network device location, as stored on the network device.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
iplnetdev_nbfreeports
The number of free ports on the network device.

632
 Network Device

iplnetdev_class_name
The name of the class applied to the network device. It must include the class file name and
the directory it belongs to, for instance, my_favorite_dir/my_class.class . The classes global
and default cannot be used. This parameter can be empty.
iplnetdev_class_parameters
The parameters of the class specified in the parameter [object]_class_name. The class can
contain several parameters, each parameter must have a maximum length of 4000 characters
and the value of each parameter must be set in the following URL style format:
metadata1=value1&metadata2=value2& . The URL value must be encoded in URL format
as defined in RFC 3986. This parameter can be empty.
snmp_id
The identifier (ID) of the SNMP configuration the network device belongs to in SOLIDserver
database. This identifier is a unique numeric key value that is automatically incremented.

633
 Network Device

Name
group_iplnetdev_add — Add a network device as group resource
Description
The service group_iplnetdev_add allows to add an object as resource for a group of users. You
must specify the group of users and the object that you set as resource. Once set as a resource,
the group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use the service group_iplnetdev_add.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

634
 Network Device

Name
group_iplnetdev_delete — Remove a network device from a group resources
Description
The service group_iplnetdev_delete allows to delete SOLIDserver database object. The service
group_iplnetdev_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

635
 Network Device

Name
iplocator_netdev_delete — Delete an IPlocator device
Description
The service iplocator_netdev_delete allows to delete network devices, or stop managing them
via SOLIDserver.You must specify the object to delete in the input. To execute this service, users
must be granted permission to use the service iplnetdev_list.The rows returned to the user running
the service depend on the resources granted to the group they belong to.

Input Parameters
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
hostaddr
The network device IP address.
iplnetdev_addr
The network device IP address.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

636
Chapter 50. VLAN

637
 VLAN

Name
iplnetdevvlan_count — Number of VLANs
Description
The service iplnetdevvlan_count allows to display the number of VLANs in the database or for a
specific network device. To execute this service, users must be granted permission to use the
service iplnetdevvlan_list. The rows returned to the user running the service depend on the re-
sources granted to the group they belong to. The WHERE input parameter allows to filter the
returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: iplnetdev_name, iplnetdev_class_name, iplnet-

dev_nbports, iplnetdev_type, iplnetdev_vendor, iplnetdev_syscontact, iplnetdev_serial, ipl-
netdev_status, iplnetdev_syslocation.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

638
 VLAN

Name
iplnetdevvlan_list — List the VLANs
Description
The service iplnetdevvlan_list allows to list the VLANs in the database or belonging to a specific
network device. To execute this service, users must be granted permission to use the service
iplnetdevvlan_list. The rows returned to the user running the service depend on the resources
granted to the group they belong to. The WHERE input parameter allows to filter the returned
rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: iplnetdev_name, iplnetdev_class_name, iplnet-

dev_nbports, iplnetdev_type, iplnetdev_vendor, iplnetdev_syscontact, iplnetdev_serial, ipl-
netdev_status, iplnetdev_syslocation.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
iplnetdev_name
The network device name.
iplnetdev_class_name
The name of the class applied to the network device. It must include the class file name and
the directory it belongs to, for instance, my_favorite_dir/my_class.class . The classes global
and default cannot be used. This parameter can be empty.

639
 VLAN

iplnetdev_nbports
The number of ports of the network device.
iplnetdev_type
The network device type.
iplnetdev_vendor
The network device vendor.
iplnetdev_syscontact
The network device administrative contact. The contact details of the person managing the
network device configuration, as stored on the network device.
iplnetdev_serial
The network device serial number.
iplnetdev_status
The network device status.
iplnetdev_syslocation
The network device location, as stored on the network device.

640
Chapter 51. Port

641
 Port

Name
iplocator_port_add — Add/Edit a network device port
Description
The service iplocator_port_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
iplport_id
The port identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
iplport_class_name
The name of the class applied to the port. It must include the class file name and the directory
it belongs to, for instance, my_favorite_dir/my_class.class . The classes global and default
cannot be used. This parameter can be empty.
iplport_class_parameters
The parameters of the class specified in the parameter [object]_class_name. The class can
contain several parameters, each parameter must have a maximum length of 4000 characters
and the value of each parameter must be set in the following URL style format:
metadata1=value1&metadata2=value2& . The URL value must be encoded in URL format
as defined in RFC 3986. This parameter can be empty.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

642
 Port

Name
iplport_count — Number of network device ports
Description
The service iplport_count allows to display the number of network device ports.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: aggregated_port_name, iplport_id, iplnetdev_ip_addr,

snmp_id, iplnetdev_vendor, iplnetdev_name, iplnetdev_type, iplnetdevvlan_name, iplnet-
dev_serial, iplnetdev_syscontact, iplnetdev_nbports, iplnetdev_status, iplnetdev_class_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

643
 Port

Name
iplport_list — List the network device ports
Description
The service iplport_list allows to list entries from SOLIDserver database. To execute this service,
users must be granted permission to use the service iplport_list. The rows returned to the user
running the service depend on the resources granted to the group they belong to. The WHERE
input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: aggregated_port_name, iplport_id, iplnetdev_ip_addr,

snmp_id, iplnetdev_vendor, iplnetdev_name, iplnetdev_type, iplnetdevvlan_name, iplnet-
dev_serial, iplnetdev_syscontact, iplnetdev_nbports, iplnetdev_status, iplnetdev_class_name.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
aggregated_port_name
The aggregated port name.
iplport_id
The port identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

644
 Port

iplport_class_name
The name of the class applied to the port. It must include the class file name and the directory
it belongs to, for instance, my_favorite_dir/my_class.class . The classes global and default
cannot be used. This parameter can be empty.
iplport_class_parameters
The parameters of the class specified in the parameter [object]_class_name. The class can
contain several parameters, each parameter must have a maximum length of 4000 characters
and the value of each parameter must be set in the following URL style format:
metadata1=value1&metadata2=value2& . The URL value must be encoded in URL format
as defined in RFC 3986. This parameter can be empty.
iplnetdev_ip_addr
The network device IP address.
snmp_id
The identifier (ID) of the SNMP configuration the port belongs to in SOLIDserver database.
This identifier is a unique numeric key value that is automatically incremented.
iplnetdev_vendor
The network device vendor.
iplnetdev_name
The network device name.
iplnetdev_type
The network device type.
iplnetdevvlan_name
The VLAN name.
iplnetdev_serial
The network device serial number.
iplnetdev_syscontact
The network device administrative contact. The contact details of the person managing the
network device configuration, as stored on the network device.
iplnetdev_nbports
The number of ports of the network device.
iplnetdev_status
The network device status.
iplnetdev_class_name
The name of the class applied to the network device. It must include the class file name and
the directory it belongs to, for instance, my_favorite_dir/my_class.class . The classes global
and default cannot be used. This parameter can be empty.

645
 Port

Name
iplport_info — Display the properties of a network device port
Description
The service iplport_info returns the information on the object specified in input.

Input Parameters
iplport_id
The port identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
aggregated_port_name
The aggregated port name.
iplport_id
The port identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
iplnetdev_ip_addr
The network device IP address.
snmp_id
The identifier (ID) of the SNMP configuration the port belongs to in SOLIDserver database.
This identifier is a unique numeric key value that is automatically incremented.
iplnetdev_vendor
The network device vendor.
iplnetdev_name
The network device name.
iplnetdev_type
The network device type.
iplnetdevvlan_name
The VLAN name.
iplnetdev_serial
The network device serial number.
iplnetdev_syscontact
The network device administrative contact. The contact details of the person managing the
network device configuration, as stored on the network device.
iplnetdev_nbports
The number of ports of the network device.
iplnetdev_status
The network device status.

646
 Port

iplnetdev_class_name
The name of the class applied to the network device. It must include the class file name and
the directory it belongs to, for instance, my_favorite_dir/my_class.class . The classes global
and default cannot be used. This parameter can be empty.

647
Chapter 52. Discovered Item

648
 Discovered Item

Name
ipldev_count — Number of discovered items
Description
The service ipldev_count allows to display the number of discovered items.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: iplnetdev_ip_addr, iplnetdev_stack_id, iplport_dev_count,

oid, iplport_id, ipldev_mac, ipldev_vlan, ipldev_time, ipldev_end_time, mac_vendor,
iplip_ip_addr, iplip_hostaddr, iplip_source, iplip_dns_name, iplip_start_time, iplip_end_time,
iplport_name, iplport_ifnumber, iplport_description, iplport_ifvlan, iplport_slotnumber, ipl-
port_secure, iplport_portnumber, iplport_interco, iplport_staticinterco, iplnetdev_id, iplnet-
dev_name, iplnetdevvlan_name, iplnetdevvlan_number, hostiface_name, hostdev_name,
hostdev_id, hostiface_id, iplport_class_name, iplport_poe, iplport_duplex, iplport_iftype, ipl-
port_ifoperstatus, iplnetdev_serial, iplnetdev_syscontact, iplnetdev_vendor, iplnetdev_type,
iplnetdev_syslocation, iplnetdev_nbports, iplnetdevvlan_status.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

649
 Discovered Item

Name
ipldev_list — List of discovered items
Description
The service ipldev_list allows to list all the devices (computers, etc.) currently connected to a
network device. To execute this service, users must be granted permission to use the service
ipldev_list. The rows returned to the user running the service depend on the resources granted
to the group they belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: iplnetdev_ip_addr, iplnetdev_stack_id, iplport_dev_count,

oid, iplport_id, ipldev_mac, ipldev_vlan, ipldev_time, ipldev_end_time, mac_vendor,
iplip_ip_addr, iplip_hostaddr, iplip_source, iplip_dns_name, iplip_start_time, iplip_end_time,
iplport_name, iplport_ifnumber, iplport_description, iplport_ifvlan, iplport_slotnumber, ipl-
port_secure, iplport_portnumber, iplport_interco, iplport_staticinterco, iplnetdev_id, iplnet-
dev_name, iplnetdevvlan_name, iplnetdevvlan_number, hostiface_name, hostdev_name,
hostdev_id, hostiface_id, iplport_class_name, iplport_poe, iplport_duplex, iplport_iftype, ipl-
port_ifoperstatus, iplnetdev_serial, iplnetdev_syscontact, iplnetdev_vendor, iplnetdev_type,
iplnetdev_syslocation, iplnetdev_nbports, iplnetdevvlan_status.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
iplnetdev_ip_addr
The network device IP address.

650
 Discovered Item

iplnetdev_stack_id
The network device stack identifier (ID). This identifier is a unique numeric key value that is
automatically incremented.
iplport_dev_count
The number of ports that the discovered item is connected to.
oid
The discovered item SNMP object identifier (OID).
iplport_id
The port identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
ipldev_mac
The discovered item MAC address.
ipldev_vlan
The discovered item VLAN.
ipldev_time
The exact time at which the item was discovered, in epoch time format.
ipldev_end_time
The exact time at which the discovered item was last seen, in epoch time format.
mac_vendor
The vendor of the network device NIC (network interface controller).
iplip_ip_addr
The IP address of the MAC address used to connect to the port.
iplip_source
The discovered item IP discovery source. This information is displayed in the GUI in the
column Source of the All discovered items list.
iplip_dns_name
The domain associated with the discovered item IP address.
iplip_start_time
The date when the discovered item MAC address was detected.
iplip_end_time
The date when the discovered item MAC address was detected for the last time.
iplport_name
The port name.
iplport_ifnumber
The number of the port interface through which the discovered item is connected to the network
device.
iplport_description
The port description.
iplport_slotnumber
The port slot number.
iplport_secure
The port-security configuration. If set to 0, the port is not secure. If set to 1, the port is secure.
iplport_portnumber
The port number.

651
 Discovered Item

iplport_interco
The port interconnection status.
iplport_staticinterco
The port static interconnection status.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
iplnetdev_name
The network device name.
iplnetdevvlan_name
The VLAN name.
iplnetdevvlan_number
The VLAN of the discovered item port.
hostiface_name
The interface name in Device Manager.
hostdev_name
The device name in Device Manager.
hostdev_id
The device identifier (ID) in Device Manager. This identifier is a unique numeric key value
that is automatically incremented.
hostiface_id
The interface identifier (ID) in Device Manager. This identifier is a unique numeric key value
that is automatically incremented.
iplport_class_name
The name of the class applied to the port. It must include the class file name and the directory
it belongs to, for instance, my_favorite_dir/my_class.class . The classes global and default
cannot be used. This parameter can be empty.
iplport_poe
The port POE status. It is set to 1 if the port provides POE. It is set to 0 if the port does not.
iplport_duplex
The port duplex mode.
iplport_iftype
The port interface type (Ethernet, GigaEthernet, FastEthernet, Aggregated).
iplport_ifoperstatus
The port interface status. It can be up or down.
iplnetdev_serial
The network device serial number.
iplnetdev_syscontact
The network device administrative contact. The contact details of the person managing the
network device configuration, as stored on the network device.
iplnetdev_vendor
The network device vendor.
iplnetdev_type
The network device type.
iplnetdev_syslocation
The network device location, as stored on the network device.

652
 Discovered Item

iplnetdev_nbports
The number of ports of the network device.
iplnetdevvlan_status
The VLAN status.

653
 Discovered Item

Name
ipldev_log_count — Track the total number of discovered item of a network device
Description
The service ipldev_log_count allows to use the discovered items MAC address to fins and display
the total number of discovered items of a network device since you started managing it with
SOLIDserver.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: iplnetdev_ip_addr, iplnetdev_stack_id, iplport_dev_count,

oid, iplport_id, ipldev_mac, ipldev_vlan, ipldev_time, ipldev_end_time, mac_vendor,
iplip_ip_addr, iplip_hostaddr, iplip_source, iplip_dns_name, iplip_start_time, iplip_end_time,
iplport_name, iplport_ifnumber, iplport_description, iplport_ifvlan, iplport_slotnumber, ipl-
port_secure, iplport_portnumber, iplport_interco, iplport_staticinterco, iplnetdev_id, iplnet-
dev_name, iplnetdevvlan_name, iplnetdevvlan_number, hostiface_name, hostdev_name,
hostdev_id, hostiface_id, iplport_class_name, iplport_poe, iplport_duplex, iplport_iftype, ipl-
port_ifoperstatus, iplnetdev_serial, iplnetdev_syscontact, iplnetdev_vendor, iplnetdev_type,
iplnetdev_syslocation, iplnetdev_nbports, iplnetdevvlan_status.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

654
 Discovered Item

Name
ipldev_log_list — Track all the discovered items of a network device
Description
The service ipldev_log_list allows to list the devices (computers, etc.) that have ever been con-
nected to a network device, as displayed on the History view in the GUI. It allows to track the
discovered items movements through their MAC address. To execute this service, users must
be granted permission to use the service ipldev_log_list. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: iplnetdev_ip_addr, iplnetdev_stack_id, iplport_dev_count,

oid, iplport_id, ipldev_mac, ipldev_vlan, ipldev_time, ipldev_end_time, mac_vendor,
iplip_ip_addr, iplip_hostaddr, iplip_source, iplip_dns_name, iplip_start_time, iplip_end_time,
iplport_name, iplport_ifnumber, iplport_description, iplport_ifvlan, iplport_slotnumber, ipl-
port_secure, iplport_portnumber, iplport_interco, iplport_staticinterco, iplnetdev_id, iplnet-
dev_name, iplnetdevvlan_name, iplnetdevvlan_number, hostiface_name, hostdev_name,
hostdev_id, hostiface_id, iplport_class_name, iplport_poe, iplport_duplex, iplport_iftype, ipl-
port_ifoperstatus, iplnetdev_serial, iplnetdev_syscontact, iplnetdev_vendor, iplnetdev_type,
iplnetdev_syslocation, iplnetdev_nbports, iplnetdevvlan_status.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

655
 Discovered Item

iplnetdev_ip_addr
The network device IP address.
iplnetdev_stack_id
The network device stack identifier (ID). This identifier is a unique numeric key value that is
automatically incremented.
iplport_dev_count
The number of ports that the discovered item is connected to.
oid
The discovered item SNMP object identifier (OID).
iplport_id
The port identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
ipldev_mac
The discovered item MAC address.
ipldev_vlan
The discovered item VLAN.
ipldev_time
The exact time at which the item was discovered, in epoch time format.
ipldev_end_time
The exact time at which the discovered item was last seen, in epoch time format.
mac_vendor
The vendor of the network device NIC (network interface controller).
iplip_ip_addr
The IP address of the MAC address used to connect to the port.
iplip_source
The discovered item IP discovery source. This information is displayed in the GUI in the
column Source of the All discovered items list.
iplip_dns_name
The domain associated with the discovered item IP address.
iplip_start_time
The date when the discovered item MAC address was detected.
iplip_end_time
The date when the discovered item MAC address was detected for the last time.
iplport_name
The port name.
iplport_ifnumber
The number of the port interface through which the discovered item is connected to the network
device.
iplport_description
The port description.
iplport_slotnumber
The port slot number.
iplport_secure
The port-security configuration. If set to 0, the port is not secure. If set to 1, the port is secure.

656
 Discovered Item

iplport_portnumber
The port number.
iplport_interco
The port interconnection status.
iplport_staticinterco
The port static interconnection status.
iplnetdev_id
The network device identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
iplnetdev_name
The network device name.
iplnetdevvlan_name
The VLAN name.
iplnetdevvlan_number
The VLAN of the discovered item port.
hostiface_name
The interface name in Device Manager.
hostdev_name
The device name in Device Manager.
hostdev_id
The device identifier (ID) in Device Manager. This identifier is a unique numeric key value
that is automatically incremented.
hostiface_id
The interface identifier (ID) in Device Manager. This identifier is a unique numeric key value
that is automatically incremented.
iplport_class_name
The name of the class applied to the port. It must include the class file name and the directory
it belongs to, for instance, my_favorite_dir/my_class.class . The classes global and default
cannot be used. This parameter can be empty.
iplport_class_parameters
The parameters of the class specified in the parameter [object]_class_name. The class can
contain several parameters, each parameter must have a maximum length of 4000 characters
and the value of each parameter must be set in the following URL style format:
metadata1=value1&metadata2=value2& . The URL value must be encoded in URL format
as defined in RFC 3986. This parameter can be empty.
iplport_poe
The port POE status. It is set to 1 if the port provides POE. It is set to 0 if the port does not.
iplport_duplex
The port duplex mode.
iplport_iftype
The port interface type (Ethernet, GigaEthernet, FastEthernet, Aggregated).
iplport_ifoperstatus
The port interface status. It can be up or down.
iplnetdev_serial
The network device serial number.

657
 Discovered Item

iplnetdev_syscontact
The network device administrative contact. The contact details of the person managing the
network device configuration, as stored on the network device.
iplnetdev_vendor
The network device vendor.
iplnetdev_type
The network device type.
iplnetdev_syslocation
The network device location, as stored on the network device.
iplnetdev_nbports
The number of ports of the network device.
iplnetdevvlan_status
The VLAN status.

658
Part VII. Workflow Services
Name
workflow_request_add — Add/Edit a Workflow request
Description
The service workflow_request_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to.

Input Parameters
request_id
The Workflow request identifier (ID). This identifier is a unique numeric key value that is
automatically incremented.
request_name
The name of the Workflow request.
request_object_type
The object of the request: dnszone for a DNS zone, block for an IPv4 block, subnet for an
IPv4 terminal subnet, pool for an IPv4 pool or ip for an IPv4 address.
request_object_id
The identifier (ID) of the requested object.
request_object_name
The name of the requested object.
request_target_type
The type of group that deals with the request. The accepted values are: group, DNS server
and VLSM space. If you do not set any value, request_target_type is automatically set to
group.

Set it to group to assign it to a specific group of users, identified with the parameter request_tar-
get_id.

Set it to DNS server to assign it to any group of users that has among its resources the DNS
server specified with the parameter request_target_name or the parameter request_target_id.

Set it to VLSM space to assign it to any group of users that has among its resources the
IPAM space specified with the parameter request_target_name or the parameter request_tar-
get_id.
request_target_name
If you set the request_target_type to DNS server, you can specify a DNS server name. Any
group with the specified DNS server among its resource can execute the request.

If you set the request_target_type to VLSM space, you can specify an IPAM space. Any
group with the specified IPAM space among its resource can execute the request.
request_target_id
If you set the request_target_type to group, specify the identifier (ID) of the group of users
that will deal with your request.

660
 workflow_request_add

If you set the request_target_type to DNS server, you can specify the identifier (ID) of a DNS
server. Any group with the specified DNS server among its resource can execute the request.

If you set the request_target_type to VLSM space, you can specify the identifier (ID) of an
IPAM space. Any group with the specified IPAM space among its resource can execute the
request.
request_source_name
This optional parameter allows to specify the name of a group of users when creating a
Workflow request. It is useful if the requestor belongs to several groups. The rights and per-
missions of the specified group are used when executing the service. Besides, all the users
of the specified group can edit the request. The group specified can be displayed in the GUI
in the column Source name.
request_admin_id
The identifier (ID) of the request manager, the user that deals with the request. It is useless
to set it when adding or editing a request, it is automatically set when the request manager
deals with the request.
request_admin_time
The last time the request was edited by a request manager. It is useless to set it when adding
or editing a request, it is automatically edited.
modify_time
The last time the request was edited, by the requestor, a request manager or any other user
with sufficient rights. It is useless to set it when adding or editing a request, it is automatically
edited.
request_status
The request status. By default, six statuses exist: accept, archive, cancel, finish, handle, new
and reject. It is useless to set it when adding a request, it is automatically set to new.

This parameter can also be return and set with statuses that you or your administrator created.
request_action
The action required in the request. The accepted values are: New, Modified and Delete. They
allow to ask for the addition, edition or deletion of the object specified in the parameter re-
quest_object_type.
request_class_name
The request_class_name is the name of the file class that will used for this object. The name
of request_class_name must include the directory of the class. The global and default class
names are reserved by the system and must never be used. For example a re-
quest_class_name parameter could be set to: my_favorite_dir/my_class.class.
request_class_parameters
The request_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The request_class_parameters parameter accepts several meta-
data values set in the following URL style format: metadata1=value1&metadata2=value2&.
To be accepted by request_class_parameters parameter the URL value must be encoded
in URL format (see RFC 3986).
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.

661
 workflow_request_add

no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.
additional_parameters
Additional parameters passed to rules.
no_usertracking
The operation visibility. If set to 1, the operation information is not stored in user tracking.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

662
Name
request_incoming_count — Number of incoming requests
Description
The service request_incoming_count allows to display the number of Workflow incoming requests.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: request_id, request_usr_login.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

663
Name
request_incoming_list — List of incoming requests
Description
The service request_incoming_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: request_id, request_usr_login, request_admin_login.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
request_id
The Workflow request identifier (ID). This identifier is a unique numeric key value that is
automatically incremented.
request_usr_login
Not documented.
request_admin_login
Not documented.

664
Name
request_outgoing_count — Number of outgoing requests
Description
The service request_outgoing_count allows to display the number of Workflow outgoing requests.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: request_id, request_usr_login, request_admin_login.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

665
Name
request_outgoing_list — List the outgoing requests
Description
The service request_outgoing_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: request_id, request_usr_login, request_admin_login.

ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
request_id
The Workflow request identifier (ID). This identifier is a unique numeric key value that is
automatically incremented.
request_usr_login
Not documented.
request_admin_login
Not documented.

666
Name
request_info — Display the properties of a Workflow request
Description
The service request_info returns the information on the object specified in input.

Input Parameters
request_id
The Workflow request identifier (ID). This identifier is a unique numeric key value that is
automatically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

667
Name
workflow_request_delete — Delete a Workflow request
Description
The service workflow_request_delete allows to delete SOLIDserver database object.The service
workflow_request_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
request_id
The Workflow request identifier (ID). This identifier is a unique numeric key value that is
automatically incremented.
request_name
The name of the Workflow request.
additional_parameters
Additional parameters passed to rules.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

668
Part VIII. Administration Services
Table of Contents
53. Services Management ............................................................................................. 671
service_list ............................................................................................................ 672
group_service_add ................................................................................................ 674
group_service_delete ............................................................................................ 675
54. Group ..................................................................................................................... 676
group_add ............................................................................................................ 677
group_count .......................................................................................................... 679
group_list .............................................................................................................. 680
group_info ............................................................................................................ 682
maintainer_group_list ............................................................................................ 684
group_admin_user_count ...................................................................................... 685
group_admin_user_list .......................................................................................... 686
group_admin_item_count ....................................................................................... 688
group_admin_item_list ........................................................................................... 689
group_admin_count ............................................................................................... 691
group_admin_list ................................................................................................... 692
group_admin_info .................................................................................................. 694
group_admin_service_list ...................................................................................... 696
group_delete ......................................................................................................... 697
55. User ........................................................................................................................ 698
user_add .............................................................................................................. 699
user_modify_password .......................................................................................... 701
user_modify_settings ............................................................................................. 702
user_info .............................................................................................................. 703
user_admin_count ................................................................................................. 705
user_admin_list ..................................................................................................... 706
user_admin_info .................................................................................................... 708
user_admin_group_list .......................................................................................... 710
user_service_list ................................................................................................... 711
group_service_list ................................................................................................. 712
group_user_add .................................................................................................... 713
group_user_delete ................................................................................................ 714
user_delete ........................................................................................................... 715
56. Custom Database and Custom Data ......................................................................... 716
custom_db_name_add .......................................................................................... 717
custom_db_name_count ........................................................................................ 718
custom_db_name_list ............................................................................................ 719
custom_db_name_info .......................................................................................... 721
custom_db_name_delete ....................................................................................... 722
custom_db_data_add ............................................................................................ 723
custom_db_data_count ......................................................................................... 724
custom_db_data_list .............................................................................................. 725
custom_db_data_delete ......................................................................................... 727
57. Class ...................................................................................................................... 728
class_add ............................................................................................................. 729
class_list ............................................................................................................... 730
class_count .......................................................................................................... 732
group_class_add ................................................................................................... 733
group_class_delete ............................................................................................... 734
class_delete .......................................................................................................... 735

670
Chapter 53. Services Management

671
 Services Management

Name
service_list — List all the services
Description
The service service_list allows to list all the existing services whether they can be granted as
resource of a group or not. Not all services can be granted access to, the output parameters in-
dicate what you can do with them and where to find them: which module they apply or whether
they are listed in the GUI. Once a service that can actually be granted as a resource is part of
the resource of a group, the user of the group can execute it, provided that they are granted access
to the relevant resources. The WHERE input parameter allows to filter the returned rows.

To execute this service, users must be granted permission to use it.

Input Parameters
WHERE
The optional WHERE parameter has the general SQL ANSI form. Any row that matches the
configuration of the WHERE clause is returned.

It can contain the following variables: service_name, service_comment, service_default,

service_show, module_name, service_usage, service_has_help.

Output Parameters
service_name
The service name.
service_comment
The service description.
service_default
The service default assignment. If set to 1, the service can be executed by any group of users
by default. That is to say that any group of users created is granted access to the service. If
set to 0, the administrators must grant access to the service if they want their user to be able
to execute it. Obviously, this applies to services that can actually be added as group resource.
service_show
The service visibility in the GUI. If set to 1, the services is listed among the services of the
properties page of a group of users. If set to 0, the service is not visible in the GUI. For in-
stance, all the *_count services are set to 0 as the number of items is visible an all listing
pages.
module_name
The name of the module the service applies to: ip for the IPAM, dhcp for the DHCP, dns for
the DNS, iplocator for NetChange, workflow for the Workflow, host for Device Manage, vlm
for VLAN Manager, access for the resources, groups and users management of the Admin-
istration module and system for the rest of the Administration module (custom databases,
custom data, etc.).
service_usage
The service type. It is either: service, macro or internal. No user can execute or grant access
to the internal services, these services are internal to SOLIDserver and run on their own
when needed.

672
 Services Management

service_has_help
The service help command availability. If set to 1, you can call the command <service-
name> help to get the list of input and output parameters. If set to 0, the help command is
unavailable for the service.

673
 Services Management

Name
group_service_add — Add a service as group resource/Grant a group access to a
service

Description
The service group_service_add allows to grant a group of users the right to execute a service.
Not all services can be granted access to, you can use the service service_list to have an overview
of the available services. You must specify the group of users and the service that you set as
resource. Once set as a resource, the group can execute the service.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
service_name
The service name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

674
 Services Management

Name
group_service_delete — Remove a service from a group resources/Deny a group
access to a service

Description
The service group_service_delete allows to delete SOLIDserver database object. The service
group_service_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
service_name
The service name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

675
Chapter 54. Group

676
 Group

Name
group_add — Add/Edit a group of users
Description
The service group_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
grp_description
Group description.
grp_category
Group category.
src_grp_id
Source group ID (for default service values).
src_grp_name
Source group name (for default service values).
parent_grp_id
The parent group identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
parent_grp_name
Parent group name.
grp_class_name
The grp_class_name is the name of the file class that will used for this object. The name of
grp_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a grp_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
grp_class_parameters
The grp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The grp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by grp_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
enabled
Manage/Unmanage.

677
 Group

row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.
no_rule_exec
Defines if rules are executed after the service is called. If its value is set to 1, no rules are
executed after the service. The default value is 0.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

678
 Group

Name
group_count — Number of groups a user belongs to
Description
The service group_count returns the number of groups the user running it belongs to.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

679
 Group

Name
group_list — List the groups a user belongs to
Description
The service group_list allows to list the groups of users that the user running the service belongs
to.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_description
Group description.

680
 Group

grp_category
Group category.
src_grp_id
Source group ID (for default service values).
src_grp_name
Source group name (for default service values).
parent_grp_id
The parent group identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
parent_grp_name
Parent group name.
grp_class_name
The grp_class_name is the name of the file class that will used for this object. The name of
grp_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a grp_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
grp_class_parameters
The grp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The grp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by grp_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

681
 Group

Name
group_info — Display the properties of a group a user belongs to
Description
The service group_info returns information one of the groups the running the service belongs to.
The group must be specified in input.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_description
Group description.
grp_category
Group category.
src_grp_id
Source group ID (for default service values).
src_grp_name
Source group name (for default service values).
parent_grp_id
The parent group identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
parent_grp_name
Parent group name.
grp_class_name
The grp_class_name is the name of the file class that will used for this object. The name of
grp_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a grp_class_name para-
meter could be set to: my_favorite_dir/my_class.class.

682
 Group

grp_class_parameters
The grp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The grp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by grp_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

683
 Group

Name
maintainer_group_list — List the groups of users used as Maintainer
Description
The service maintainer_group_list allows to list all the group of users that have been set as
Maintainer group for users.

To execute this service, users must be granted permission to use the service maintainer_group_list.
The rows returned to the user running the service depend on the resources granted to the group
they belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.

684
 Group

Name
group_admin_user_count — Total number of users in a group of users
Description
The service group_admin_user_count allows to display the total number of users of a group of
users. The rows returned to the user running the service are not subject to the group resources,
this service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, item_id, t_type, t_oid, t_value1,
t_value2, t_value3, t_value4.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

685
 Group

Name
group_admin_user_list — List all the users of a group of users
Description
The service group_admin_user_list allows to list all the users of a group of users. The rows re-
turned to the user running the service are not subject to the group resources, this service returns
data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, item_id, t_type, t_oid, t_value1,
t_value2, t_value3, t_value4.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.

686
 Group

item_id
Not documented.
t_type
Not documented.
t_oid
Not documented.
t_value1
Not documented.
t_value2
Not documented.
t_value3
Not documented.
t_value4
Not documented.

687
 Group

Name
group_admin_item_count — Total number of resources in a group of users
Description
The service group_admin_item_count allows to display the total number of resources of a group
of users. The rows returned to the user running the service are not subject to the group resources,
this service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, item_id, t_type, t_oid, t_value1,
t_value2, t_value3, t_value4.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belong to. It matches the WHERE clause, if provided.

688
 Group

Name
group_admin_item_list — List all the resources of a group of users
Description
The service group_admin_item_list allows to list all the resources of a group of users. The rows
returned to the user running the service are not subject to the group resources, this service returns
data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, grp_name, item_id, t_type, t_oid, t_value1,
t_value2, t_value3, t_value4.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.

689
 Group

item_id
Not documented.
t_type
Not documented.
t_oid
Not documented.
t_value1
Not documented.
t_value2
Not documented.
t_value3
Not documented.
t_value4
Not documented.

690
 Group

Name
group_admin_count — Total number of group of users
Description
The service group_admin_count allows to display the total number of groups of users. The rows
returned to the user running the service are not subject to the group resources, this service returns
data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: grp_id, parent_grp_name.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

691
 Group

Name
group_admin_list — List all the groups of users
Description
The service group_admin_list allows to list all the existing groups of users. The rows returned to
the user running the service are not subject to the group resources, this service returns data as
if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_description
Group description.

692
 Group

grp_category
Group category.
src_grp_id
Source group ID (for default service values).
src_grp_name
Source group name (for default service values).
parent_grp_id
The parent group identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
parent_grp_name
Parent group name.
grp_class_name
The grp_class_name is the name of the file class that will used for this object. The name of
grp_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a grp_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
grp_class_parameters
The grp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The grp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by grp_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

693
 Group

Name
group_admin_info — Display all the properties of a group of users
Description
The service group_admin_info returns information on all the existing group of users. The rows
returned to the user running the service are not subject to the group resources, this service returns
data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_description
Group description.
grp_category
Group category.
src_grp_id
Source group ID (for default service values).
src_grp_name
Source group name (for default service values).
parent_grp_id
The parent group identifier (ID). This identifier is a unique numeric key value that is automat-
ically incremented.
parent_grp_name
Parent group name.
grp_class_name
The grp_class_name is the name of the file class that will used for this object. The name of
grp_class_name must include the directory of the class. The global and default class names

694
 Group

are reserved by the system and must never be used. For example a grp_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
grp_class_parameters
The grp_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The grp_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by grp_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).

695
 Group

Name
group_admin_service_list — List all the rights of a group of users
Description
The service group_admin_service_list allows to list all the services/rights granted to a group of
users. The rows returned to the user running the service are not subject to the group resources,
this service returns data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

696
 Group

Name
group_delete — Delete a group of users
Description
The service group_delete allows to delete a group of users.Yous must specify the group to delete
in input.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

697
Chapter 55. User

698
 User

Name
user_add — Add/Edit a user
Description
The service user_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
login
User login.
usr_login
User login.
description
User description.
usr_description
User description.
fname
User first name.
usr_fname
User first name.
lname
User last name.
usr_lname
User last name.
email
User email.
usr_email
User email.
type
User type (local/passwd/pam/rule).
usr_type
User type (local/passwd/pam/rule).
path
User login url.
usr_path
User login url.

699
 User

password
User password.
usr_password
User password.
www_settings
User settings (URL).
usr_www_settings
User settings (URL).
maintainer_grp_id
The identifier (ID) of the maintainer group set for the user. This identifier is a unique numeric
key value that is automatically incremented.
maintainer_grp_name
The name of the maintainer group set for the user. This identifier is a unique numeric key
value that is automatically incremented.
usr_class_name
The usr_class_name is the name of the file class that will used for this object. The name of
usr_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a usr_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
usr_class_parameters
The usr_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The usr_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by usr_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
enabled
Manage/Unmanage.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
changed_waiting_state
Changed waiting state (Internal).
keep_class_parameters
Allows to keep existing class parameters. The parameter value must be 0 or 1. If set to 1,
the value of the parameter [object]_class_parameters is added to the existing class paramet-
ers.
add_flag
Allows to flag the creation type. The flag can be either new_only, edit_only or new_edit.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

700
 User

Name
user_modify_password — Edit the password of a user
Description
The service user_modify_password allows to edit a user password.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
password
User password.
usr_password
User password.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

701
 User

Name
user_modify_settings — Edit the settings of a user
Description
The service user_modify_settings allows to edit a user properties.

To execute this service, users must be granted permission to use it. The rows returned to the
user running the service depend on the resources granted to the group they belong to. The
WHERE input parameter allows to filter the returned rows.

Input Parameters
www_settings
User settings (URL).
usr_www_settings
User settings (URL).

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

702
 User

Name
user_info — Display the properties of the user running the service
Description
The service user_info returns the information on the user running it.

To execute this service, users must be granted permission to use it.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
usr_login
User login.
usr_type
User type (local/passwd/pam/rule).
usr_path
User login url.
usr_description
User description.
usr_fname
User first name.

703
 User

usr_lname
User last name.
usr_email
User email.
usr_www_settings
User settings (URL).
usr_class_name
The usr_class_name is the name of the file class that will used for this object. The name of
usr_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a usr_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
usr_class_parameters
The usr_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The usr_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by usr_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
maintainer_grp_id
The identifier (ID) of the maintainer group set for the user. This identifier is a unique numeric
key value that is automatically incremented.
maintainer_grp_name
The name of the maintainer group set for the user. This identifier is a unique numeric key
value that is automatically incremented.

704
 User

Name
user_admin_count — Total number of users
Description
The service user_admin_count allows to display the total number of users. The rows returned to
the user running the service are not subject to the group resources, this service returns data as
if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: usr_id, row_enabled, usr_login, usr_type, usr_descrip-
tion, usr_lname, usr_fname, usr_custom1, usr_custom2, usr_custom3, usr_class_name,
usr_class_parameters, waiting_state, waiting_status, maintainer_grp_name, maintain-
er_grp_id, usr_email, usr_path.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belongs to. It matches the WHERE clause, if provided.

705
 User

Name
user_admin_list — List all the users
Description
The service user_admin_list allows to list all the existing users. The rows returned to the user
running the service are not subject to the group resources, this service returns data as if the user
running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: usr_id, row_enabled, usr_login, usr_type, usr_descrip-
tion, usr_lname, usr_fname, usr_custom1, usr_custom2, usr_custom3, usr_class_name,
usr_class_parameters, waiting_state, waiting_status, maintainer_grp_name, maintain-
er_grp_id, usr_email, usr_path.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

706
 User

row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
usr_login
User login.
usr_type
User type (local/passwd/pam/rule).
usr_description
User description.
usr_lname
User last name.
usr_fname
User first name.
usr_class_name
The usr_class_name is the name of the file class that will used for this object. The name of
usr_class_name must include the directory of the class. The global and default class names
are reserved by the system and must never be used. For example a usr_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
usr_class_parameters
The usr_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The usr_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by usr_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
waiting_state
State of the pending creation used when update third external database as Internet registrar.
waiting_status
Status of the pending operation.
maintainer_grp_name
The name of the maintainer group set for the user. This identifier is a unique numeric key
value that is automatically incremented.
maintainer_grp_id
The identifier (ID) of the maintainer group set for the user. This identifier is a unique numeric
key value that is automatically incremented.
usr_email
User email.
usr_path
User login url.

707
 User

Name
user_admin_info — Display all the properties of a user
Description
The service user_admin_info returns information on all the existing users. The rows returned to
the user running the service are not subject to the group resources, this service returns data as
if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
row_enabled
The object activation status. If set to 0, the object is in the database but ignored (it is not
visible in the GUI and cannot be managed, counted or listed). If set to 1, the object can be
managed normally. By default, row_enabled is set to 1 when an object is created.
usr_login
User login.
usr_type
User type (local/passwd/pam/rule).
usr_description
User description.
usr_lname
User last name.
usr_fname
User first name.
usr_class_name
The usr_class_name is the name of the file class that will used for this object. The name of
usr_class_name must include the directory of the class. The global and default class names

708
 User

are reserved by the system and must never be used. For example a usr_class_name para-
meter could be set to: my_favorite_dir/my_class.class.
usr_class_parameters
The usr_class_parameters parameter is a data container used to store your customized
meta-data. This meta-data can be apply for the class object definition and for the global
customized fields as well. The usr_class_parameters parameter accepts several meta-data
values set in the following URL style format: metadata1=value1&metadata2=value2&. To be
accepted by usr_class_parameters parameter the URL value must be encoded in URL format
(see RFC 3986).
waiting_state
State of the pending creation used when update third external database as Internet registrar.
waiting_status
Status of the pending operation.
maintainer_grp_name
The name of the maintainer group set for the user. This identifier is a unique numeric key
value that is automatically incremented.
maintainer_grp_id
The identifier (ID) of the maintainer group set for the user. This identifier is a unique numeric
key value that is automatically incremented.
usr_email
User email.
usr_path
User login url.

709
 User

Name
user_admin_group_list — List all the groups a user belongs to
Description
The service user_admin_group_list allows to list all the groups a user belongs to. The rows re-
turned to the user running the service are not subject to the group resources, this service returns
data as if the user running it belonged to the admin group.

To execute this service, users must be granted permission to use it. The WHERE input parameter
allows to filter the returned rows.

Input Parameters
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
from_type
Not documented.

710
 User

Name
user_service_list — List the services that a user can execute
Description
The service user_service_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The WHERE input parameter allows to filter
the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
service_name
The service name.
module_name
The name of the module the service applies to: ip for the IPAM, dhcp for the DHCP, dns for
the DNS, iplocator for NetChange, workflow for the Workflow, host for Device Manage, vlm
for VLAN Manager, access for the resources, groups and users management of the Admin-
istration module and system for the rest of the Administration module (custom databases,
custom data, etc.).
link_active
The service activation status. If set to 1, it is active. If set to 0 it is not active.

711
 User

Name
group_service_list — List the services that a user can execute according to the groups
they belong to

Description
The service group_service_list allows to list entries from SOLIDserver database. To execute this
service, users must be granted permission to use it. The rows returned to the user running the
service depend on the resources granted to the group they belong to. The WHERE input para-
meter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: all the output parameters that are specific to the object
can be used in the clause.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
grp_name
The name of the group of users.
module_name
The name of the module the service applies to: ip for the IPAM, dhcp for the DHCP, dns for
the DNS, iplocator for NetChange, workflow for the Workflow, host for Device Manage, vlm
for VLAN Manager, access for the resources, groups and users management of the Admin-
istration module and system for the rest of the Administration module (custom databases,
custom data, etc.).
service_name
The service name.
link_active
The service activation status. If set to 1, it is active. If set to 0 it is not active.

712
 User

Name
group_user_add — Add a user as group resource
Description
The service group_user_add allows to add a user as resource for a group of users, in other words,
to add a user to a group. You must specify the group of users and the object that you set as re-
source. Once set as a resource, the user is granted access to all the services and object (re-
sources) of the group.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

713
 User

Name
group_user_delete — Remove a user from a group resources
Description
The service group_user_delete allows to delete SOLIDserver database object. The service
group_user_delete needs to identify the object to delete with the input parameters detailed in the
next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

714
 User

Name
user_delete — Delete a user
Description
The service user_delete allows to delete a user. You must specify the user in input. To execute
this service, users must be granted permission to use it. Its successful execution also depends
on the resources granted to the group they belong to.

Input Parameters
usr_id
The user identifier (ID). This identifier is a unique numeric key value that is automatically in-
cremented.
login
User login.
usr_login
User login.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

715
Chapter 56. Custom Database and
Custom Data

716
 Custom Database and Custom Data

Name
custom_db_name_add — Add/Edit a custom database
Description
The service custom_db_name_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
custom_db_name_id
The identifier (ID) of the custom database. This ID must be used for any change on this
custom database.
name
Name of the custom database that you want to create. This field is mandatory.
type
Type is a free text data. It allows you to define a type of database.
descr
This is an optional field to describe the database.
label1 to label10
Name the columns of the custom database. The column is an entry of the database, you can
set up to 10 columns in each database.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

717
 Custom Database and Custom Data

Name
custom_db_name_count — Number of custom databases
Description
The service custom_db_name_count allows to display the number of custom databases. To ex-
ecute this service, users must be granted permission to use the service custom_db_name_count.
The rows returned to the user running the service depend on the resources granted to the group
they belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: custom_db_name_id, descr, name, type, read_only,
label1, label2, label3, label4, label5, label6, label7, label8, label9, label10.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belong to. It matches the WHERE clause, if provided.

718
 Custom Database and Custom Data

Name
custom_db_name_list — List the custom databases
Description
The service custom_db_name_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: custom_db_name_id, descr, name, type, read_only,
label1, label2, label3, label4, label5, label6, label7, label8, label9, label10.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
custom_db_name_id
Unique identifier of the custom database.
descr
This is an optional field to describe the database.
name
Name of the custom database.

719
 Custom Database and Custom Data

type
Define the type of custom database.
read_only
No documented.
label1 to label10
Name the columns of the custom database. The column is an entry of the database, you can
set up to 10 columns in each database.

720
 Custom Database and Custom Data

Name
custom_db_name_info — Display the properties of a custom database
Description
The service custom_db_name_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use it. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

Input Parameters
custom_db_name_id
Unique identifier of the custom database.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
custom_db_name_id
Unique identifier of the custom database.
descr
This is an optional field to describe the database.
name
Name of the custom database.
type
Define the type of custom database.
read_only
No documented.
label1 to label10
Name the columns of the custom database. The column is an entry of the database, you can
set up to 10 columns in each database.

721
 Custom Database and Custom Data

Name
custom_db_name_delete — Delete a custom database
Description
The service custom_db_name_delete allows to delete SOLIDserver database object. The service
custom_db_name_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object

Input Parameters
selected_query
The selected_query parameter allows to use a sub query to select the data row to delete.
The selected_query parameter has the general SQL ANSI form.The selected_query condition
is any expression that evaluates to a result of type boolean. Any row that does not satisfy
this condition will be eliminated from the deletion.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

722
 Custom Database and Custom Data

Name
custom_db_data_add — Add/Edit custom data
Description
The service custom_db_data_add_php allows to add new entries to the database or to update
it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
custom_db_name_id
The identifier (ID) of the custom database. This ID is mandatory.
custom_db_data_id
The identifier (ID) of the custom database entry (value).
name
Name of the custom DB that you want to create. This field is mandatory.
type
Type is a free text data. It allows you to define a type of database.
descr
This is an optional field to describe the database.
label1 to label10
Name the columns of the custom database. The column is an entry of the database, you can
set up to 10 columns in each database.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

723
 Custom Database and Custom Data

Name
custom_db_data_count — Number of custom data entries in a custom database
Description
The service custom_db_data_count allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use the service custom_db_data_count. The
rows returned to the user running the service depend on the resources granted to the group they
belong to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional WHERE parameter has the general SQL ANSI form. Any row that matches the
configuration of the WHERE clause is returned.

It can contain the following variables: custom_db_name_id, descr, name, type, read_only,
label1, label2, label3, label4, label5, label6, label7, label8, label9, label10.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Total number of objects. It depends on the resources of the group that the user running the
service belong to. It matches the WHERE clause, if provided.

724
 Custom Database and Custom Data

Name
custom_db_data_list — List the custom data entries
Description
The service custom_db_data_list allows to list entries from SOLIDserver database. To execute
this service, users must be granted permission to use the service custom_db_data_list. The rows
returned to the user running the service depend on the resources granted to the group they belong
to. The WHERE input parameter allows to filter the returned rows.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: custom_db_data_id, custom_db_name_id, value1,

value2, value3, value4, value5, value6, value7, value8, value9, value10.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
custom_db_data_id
The identifier (ID) of the custom database entry (value).
custom_db_name_id
The identifier (ID) of the custom database.
descr
Not documented.

725
 Custom Database and Custom Data

name
Not documented.
type
Not documented.
read_only
Not documented.
label1 to label10
Name the columns of the custom database. The column is an entry of the database, you can
set up to 10 columns in each database.
value1 to value10
The value of the database entries, if you have 10 columns, you have 10 corresponding entries.

726
 Custom Database and Custom Data

Name
custom_db_data_delete — Delete custom data
Description
The service custom_db_data_delete allows to delete SOLIDserver database object. The service
custom_db_data_delete needs to identify the object to delete with the input parameters detailed
in the next section. This service will be executed if the connected user running this service is al-
lowed to delete the concerned object.

Input Parameters
selected_query
The selected_query parameter allows to use a sub query to select the data row to delete.
The selected_query parameter has the general SQL ANSI form.The selected_query condition
is any expression that evaluates to a result of type boolean. Any row that does not satisfy
this condition will be eliminated from the deletion.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

727
Chapter 57. Class

728
 Class

Name
class_add — Add/Edit a class
Description
The service class_add allows to add new entries to the database or to update it.

If the identifier of the object is not specified, a new entry is created. If an existing identifier is
specified, the corresponding entry configuration is edited with all the parameters specified in input.
To remove a parameter, set it to null.

To execute this service, users must be granted the permission to use it. The rows returned to
the user running the service depend on the resources granted to the group they belong to

Input Parameters
Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

729
 Class

Name
class_list — List all the enabled classes
Description
The service class_list allows to list Class Studio classes with a status Enabled. The classes
global and default that are not returned by this service. The rows returned to the user running
the service depend on the resources granted to the group they belong to. The WHERE input
parameter allows to filter the returned rows.

To execute this service, users must be granted permission to use it.

Input Parameters
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: class_id, class_name, class_description, class_type,

class_category, class_is_template.
ORDERBY
The optional parameter ORDERBY follows the general SQL ANSI form. It sets the order of
the output parameters returned, using their name or ordinal number.

If a parameter has the same value in two different rows, the next parameter of each row is
compared. If that second parameter is still the same for both rows, the next parameter of
each row is compared, and so on until all the rows are ordered according to the configuration
you set in the ORDERBY clause. If all the parameters of the rows are equal, they are returned
in an implementation-dependent order.

Users can add the optional keyword ASC (ascending) or DESC (descending) after any ex-
pression in the ORDERBY parameter. If not specified, ASC is assumed by default. The OR-
DERBY parameter can use the same variables as the WHERE clause.
offset
This optional parameter indicates the number of rows to skip in the service output.
limit
This optional parameter can be used to limit the number of rows returned. Once set, the
number of rows does not exceed the value set. However it can return less rows, depending
on the user resources, the input configuration or the database content.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
class_id
The class_id parameter is the Class identifier (ID). This identifier is a unique numeric key
value that is automatically incremented.
class_name
The class name.

730
 Class

class_description
The class description.
class_type
The class type, i.e. the object the class applies to.
class_category
Not documented.
class_is_template
Indicates if the class is used as template class (1) or not (0).

731
 Class

Name
class_count — Number of enabled classes
Description
The service class_count allows to count Class Studio classes with a status Enabled. The classes
global and default that are not returned by this service. To execute this service, users must be
granted permission to use it. The rows returned to the user running the service depend on the
resources granted to the group they belong to. The WHERE input parameter allows to filter the
returned rows.

Input Parameters
class_id
The class identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.
class_name
The class name.
WHERE
The optional parameter WHERE follows the general SQL ANSI form. Any row that matches
the configuration of the WHERE clause is returned.

It can contain the following variables: class_id, class_name, class_description, class_type,

class_category, class_is_template.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.
total
Number of objects returned, it depends on the resources of the group and matches the
WHERE clause, if provided.

732
 Class

Name
group_class_add — Add a class as group resource
Description
The service group_class_add allows to add an object as resource for a group of users. You must
specify the group of users and the object that you set as resource. Once set as a resource, the
group can manage the object according to the rights services it has access to.

To execute this service, users must be granted permission to use it.

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
class_id
The class identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

733
 Class

Name
group_class_delete — Remove a class from a group resources
Description
The service group_class_delete allows to delete SOLIDserver database object. The service
group_class_delete needs to identify the object to delete with the input parameters detailed in
the next section. This service will be executed if the connected user running this service is allowed
to delete the concerned object

Input Parameters
grp_id
The group of users identifier (ID). This identifier is a unique numeric key value that is auto-
matically incremented.
grp_name
The name of the group of users.
class_id
The class identifier (ID). This identifier is a unique numeric key value that is automatically
incremented.

Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

734
 Class

Name
class_delete — Delete a class
Description
The service class_delete allows to delete SOLIDserver database object. The service class_delete
needs to identify the object to delete with the input parameters detailed in the next section. This
service will be executed if the connected user running this service is allowed to delete the con-
cerned object

Input Parameters
Output Parameters
errno
Status returned by the service after its execution. If the operation is successful, it returns 0.
If the operation fails, it returns other numbers detailed in the appendix Return code.

735
Appendix A. Return Codes
This section contains the API (Application Programming Interface) return codes for SOLIDserver.
For each return code, the following information is provided:

• Code: this number corresponds to the number returned by each webservice.

• Level: indicates the level that generated the return code. The possible severity codes and their
meanings include:
• Error: the web service processing cannot continue.
• Warning: the web service processing can continue, but problems might develop later. You
should be cautious.
• Notice: the web service processing can continue, but an issue has been detected.
• Description: explains the circumstances under which this return code might be generated.

Table A.1.
Code Level Description
000004 Error Missing parameter(s) [<parameters>]
000005 Error Bad parameter(s) [<parameters>=<param_value>]
000006 Error Permission denied. [<errmsg>]
000010 Error Parameter '<parameter>' too long (<max_size> max)
000011 Error Object '<obj_name>' already exists
000012 Error Bad parameter format (<parameters>) (<param_value>)
000013 Error Value cannot be changed (parameter: <parameter>, pre-
vious value: <prev_value>, new value: <new_value>)
000014 Error Invalid license
000015 Error Internal protocol error (too many values)
000016 Error Syntax error at line <line> near "<token>"
000017 Error Object does not exist
000100 Error Failed to perform your action. (action: <action>, object:
<object>)
000101 Notice Object added (object: <object>)
000102 Notice Object deleted (object: <object>)
000103 Notice Object modified (object: <object>)
000104 Error Object already exists
000105 Error Cannot modify the parameter
000106 Error This value already exists
000107 Error Functionality not applicable for this object (object: <ob-
ject_name>, type: <object_type>)
000108 Error Can't find object
000200 Notice Action successfully completed
000201 Notice File "<file>" deleted
000202 Error File "<file>" already exists

736
 Return Codes

Code Level Description

000203 Notice Class "<file>" copied
000204 Error Class "<file>" already used. Can't be deleted, moved,
enabled or disabled as a template replication
000205 Notice Class "<file>" renamed
000206 Notice Class "<file>" duplicated
000207 Notice Class "<file>" has been moved
000208 Notice Initialization completed
000209 Error The class "<file>" already exists
000210 Error Classes located inside 'Library' directory can not be
handled
000211 Error This class can not be moved or added to the Library
000212 Error Enabling a space class as a template is not allowed
000213 Error Enabling an IP address class as template is not allowed
000300 Error Could not retrieve WSDL file
000301 Error The variable you' trying to access does not exist !
000400 Error Could not set an appropriate failover channel to the subnet
<subnet_name> (<space_name> / <subnet_addr>), be-
cause <failovers> were found. You will have to update it
manually in the subnets listing.
000401 Error Classes with same name in blocks and subnets exist.
Please rename one of this classes: <path><class_name>
000402 Error The failover channel "<dhcpfailover_name>" cannot be
applied to the subnet "<subnet_name>" (<subnet_addr>).
In the space "<site_name>", this subnet has already been
configured with the failover "<old_dhcpfailover_name>".
000403 Error The default behaviors of the DHCP scope "<dhcpscope>"
of the server "<dhcp_name>" cannot be replicated to the
IPAM: at least one of the existing subnets matches it.
000404 Error The default behaviors of the type A DNS RR "<hostaddr>"
(<ip_name>) cannot be replicated to the IPAM: at least
one IP address matches it.
000405 Error The default behaviors of the DHCP static "<hostaddr>"
linked to the MAC address "<mac_addr>" cannot be rep-
licated to the IPAM: at least one IP address matches it.
000450 Notice Migration done
002001 Error Cannot find master zone (<dnszone_name>)
002002 Error Cannot choose the master zone
002003 Error Invalid RR
002004 Error The server didn't answer in time to the request for a new
RR
002005 Error The server didn't answer in time to the RR deletion request
002006 Error There is more than one zone available for delegation

737
 Return Codes

Code Level Description

002007 Error The server did not answer in time to the request for a new
zone
002008 Error The server did not answer in time to the zone deletion
request
002009 Error The server did not answer in time to the request for a new
ACL
002010 Error The server did not answer in time to the ACL deletion re-
quest
002011 Error Cannot delete the last NS RR
002012 Error DNS zone already exists
002020 Error You must select DNS zones
002021 Error You must select DNS records
002022 Error Cannot migrate a SOA or NS RR.
002023 Error You must select a DNS master zone
002024 Error The zone does not exist
002025 Notice DNS RR deleted (name: <value1>, zone:
<dnszone_name>, view: <dnsview_name>, server:
<dns_name>)
002026 Notice DNS zone deleted (name: <dnszone_name> view:
<dnsview_name> server: <dns_name>)
002027 Notice DNS view deleted (name: <dnsview_name> server:
<dns_name>)
002028 Notice DNS server deleted (name: <dns_name>)
002029 Notice DNS zone enabled (name: <dnszone_name>, view:
<dnsview_name>, server: <dns_name>)
002030 Notice DNS zone disabled (name: <dnszone_name>, view:
<dnsview_name> ,server: <dns_name>)
002031 Notice DNS zone synchronized (name: <dnszone_name>, view:
<dnsview_name>, server: <dns_name>)
002032 Notice DNS server synchronized (name: <dns_name>)
002033 Error There is no view for this DNS server
002034 Notice DNS RR added (<rr_name>)
002035 Notice DNS zone added (<dnszone_name>)
002036 Error You must select a slave DNS zone
002037 Error This server is a not an EfficientIP NS one
002039 Notice DNS zone added
002040 Error You must select a slave/stub DNS zone
002041 Error The DNS zone is empty
002042 Notice DNS refresh
002043 Notice DNS notify
002044 Notice DNS retransfer

738
 Return Codes

Code Level Description

002045 Error The value to Replace was not found
002046 Notice DNS cache flushed
002047 Notice The DNS querylog command has been toggled
002048 Notice DNS view "<dnsview_name>" added
002049 Notice DNS key "<key_name>" added
002051 Error The target zone <dnszone_name> does not exist and you
have not granted external domain management
002052 Notice DNS ACL <dnsacl_name> successfully created.
002053 Error The RR A <rr_name> in the zone <dnszone_name> does
not exist
002054 Notice DNS view updated
002055 Error DNS key is used (<object_type> <object_name>)
002056 Notice DNS ACL deleted
002057 Notice DNS KEY deleted
002058 Error DNS ACL is used (<object_type> <object_name>)
002059 Error Cant change zone type
002060 Error DNS name already exist
002061 Error RR name already used (name:<rr_glue>
zone:<dnszone_name> type:<rr_type>)
002062 Error Cannot delete a child DNS server
002063 Error Cannot delete a SMART DNS server with children
002064 Error Cannot change the RR type
002065 Error DNS server name already exist (name: <dns_name>)
002066 Error DNS server address already exists (address: <hostaddr>)
002067 Error Cannot change DNS server type (from: <from>, to: <to>)
002068 Notice DNS server created (name: <dns_name>)
002069 Error DNS server is in read-only mode (SMART DNS member)
002070 Warning You've selected the same zone for source and destination
002071 Error The filter validation not allowed this RR "<rr_name>"
002072 Error You do not have the right to handle this IP address
"<ip_address>"
002073 Error You do not have the right to handle this IP address pointed
by this RR CNAME or the RR A does not exist
002074 Error The filter ban not allowed this RR "<rr_name>"
002075 Error DNS server parameter already exists
002076 Error Could not find the specified DNS server.
002077 Error Could not find the specified DNS zone.
002078 Error Cannot delete the ACL "<dnsacl_name>".
002079 Error Cannot delete the parameter <param_key>, it doesn't
exist.

739
 Return Codes

Code Level Description

002080 Error The specified parameter cannot be deleted as it doesn't
exist.
002081 Error Cannot delete SOA
002082 Error Cannot send RNDC commands on this kind of DNS
server.
002083 Error RNDC command failed
002084 Error Existing A RR with same hostname (RR: <rr_value1>)
002085 Error Existing A RR with same IP address (shortname:
<rr_glue> , zone name: <dnszone_name> , server:
<dns_name>)
002086 Error Views are not supported on this kind of DNS server.
002087 Error Invalid property name.
002088 Warning The option "<option>" is not supported for the object
"<objectname>" (<type>). This option will be removed
from the database.
002089 Error The ACL "<name>" is not properly configured.
002090 Notice The DNS zone was created
002091 Notice The DNS view was created
002202 Notice User enabled (name: <usr_login>)
002203 Notice User disabled (name: <usr_login>)
002204 Notice Group enabled (name: <grp_name>)
002205 Notice Group disabled (name: <grp_name>)
002206 Notice Objects add/delete to groups
002207 Error Cannot copy right admin group
002208 Error User without group cannot connect to SOLIDServer,
please contact your administrator.
002209 Error Group already exist (name: <grp_name>)
002210 Error User already exist (login: <usr_login>)
002211 Error Cannot change parent group: group loop
002212 Error Cannot delete admin group
002213 Error Cannot delete a parent group
002214 Error Cannot find user
002215 Error Cannot delete ipmadmin user
002216 Error Cannot change non local password
002217 Error Cannot find group or user
002218 Error Cannot find group or space
002219 Error Cannot find group or block
002220 Error Cannot find group or subnet
002221 Error Cannot find group or pool
002222 Error Cannot find group or block v6

740
 Return Codes

Code Level Description

002223 Error Cannot find group or subnet v6
002224 Error Cannot find group or pool v6
002225 Error Cannot find group or DHCP server
002226 Error Cannot find group or DHCP scope
002227 Error Cannot find group or DNS server
002228 Error Cannot find group or DNS view
002229 Error Cannot find group or DNS zone
002230 Error Cannot find group or class
002231 Error Cannot find group or service
002232 Error Only users in the admin group can connect to SOLIDServ-
er.
002300 Notice Ping OK (<hostaddr>)
002301 Error Ping timeout (<hostaddr>)
002400 Notice Rule enabled (name: <rule_name>)
002401 Notice Rule disabled (name: <rule_name>)
002402 Notice Rule initialized (name: <rule_name>)
002403 Notice Rule deleted (name: <rule_name>)
002405 Error Cannot initialize disabled rule
002501 Error The server did not answer in time to the request for a new
scope
002502 Error The server did not answer in time to the request for scope
deletion
002503 Error The server did not answer in time to the request for a new
option
002504 Error The server didn't answer in time to the request for option
deletion
002505 Error The server did not answer in time to the request for a new
static
002506 Error The server didn't answer in time to the request for static
deletion
002507 Error The server did not answer in time to the request for a new
range
002508 Error The server didn't answer in time to the request for range
deletion
002509 Error Static already exist (name: <dhcphost_name>, address:
<dhcphost_addr>, DHCP server: <dhcp_name>)
002510 Error Range overlap [<range_name>]
002511 Error Cannot change DHCP static IP address on a Microsoft
DHCP server
002512 Error Cannot change the DHCP static MAC address on a DCS
DHCP server

741
 Return Codes

Code Level Description

002514 Error Can't delete a group with statics
002520 Error You must first select DHCP ranges
002521 Error You must first select DHCP scopes
002522 Error You must first select DHCP leases
002523 Notice DHCP server deleted (name: <dhcp_name>)
002524 Notice DHCP group deleted (name: <dhcpgroup_name>)
002525 Notice DHCP failover channel deleted (name: <dhcpfail-
over_name>)
002526 Notice DHCP range deleted (name: <dhcprange_name>)
002527 Notice DHCP scope deleted (name: <dhcpscope_name>)
002528 Notice DHCP static deleted (name: <dhcphost_name>)
002529 Notice DHCP ACL deleted (name: <dhcpclass_name>)
002530 Notice DHCP ACL data deleted (name: <dhcpsubclass_value>)
002531 Notice DHCP lease deleted (name: <dhcplease_name>)
002532 Notice Scope modified (name: <dhcpscope_name>, modified
parameter: <parameter>)
002533 Notice Scope <dhcpscope_name> copied
002534 Notice Static <dhcphost_name> copied
002535 Notice Static option created (name: <dhcpoption_name>)
002536 Notice Static option deleted (name: <dhcpoption_name> )
002537 Notice Scope <dhcpscope_name> moved
002538 Notice Scope <dhcpscope_name> created
002539 Notice Scope option created (name: <dhcpoption_name>)
002540 Notice DHCP range <dhcprange_name> created
002541 Notice DHCP range option created (name: <dhcpoption_name>)
002542 Notice DHCP range option deleted (name: <dhcpoption_name>)
002543 Notice Option <dhcpoption_name> modified (value: <value>)
002544 Notice DHCP server synchronized (name: <dhcp_name>)
002545 Notice Added group to the static <dhcphost_name>
002546 Notice Static <dhcphost_name> created
002547 Notice Option <dhcpoption_name> modified on static <dhc-
phost_name>
002548 Notice Failover channel modified on range <dhcprange_name>
002549 Error The start address (<new_start_addr>) is grater than the
end address (<new_end_addr>) on the range "<dhc-
prange_name>"
002550 Warning Could not modify the range <dhcprange_name> : rolling
back to the previous range state
002551 Notice Static <dhcphost_name> modified
002552 Notice ACL <dhcpclass_name> created

742
 Return Codes

Code Level Description

002553 Notice ACL data created on <dhcpclass_name>
002554 Notice ACL option created on <dhcpclass_name>
002555 Notice Data option <dhcpoption_name> created on ACL <dhcp-
class_name>
002556 Notice DHCP server option created (name: <dhcpoption_name>)
002557 Notice DHCP shared network created
002558 Notice DHCP server option definition created (option: <op-
tiondef_name>, DHCP server: <dhcp_name>)
002559 Notice DHCP range option created (name: <dhcpoption_name>)
002560 Notice Option <dhcpoption_name> modified (value: <value>)
002561 Error ACL not configured for this DHCP server (name: <dhcp-
class_name>)
002562 Error Shared network not configured for this DHCP server
002563 Error DHCP scope already exists (address: <dhcpscope_addr>,
DHCP server: <dhcp_name>)
002564 Error DHCP range already exists (address: <dhcprange_addr>,
DHCP server: <dhcp_name>)
002565 Error Cannot find a DHCP server or a DHCP scope
002566 Error Cannot find DHCP server
002567 Error DHCP ACL already exists (name: <dhcpclass_name>,
DHCP server: <dhcp_name>)
002568 Error Cannot find a DHCP server or an ACL
002569 Error DHCP ACL data already exists (value: <dhcpsub-
class_name>, ACL name: <dhcpclass_name>, DHCP
server: <dhcp_name>)
002570 Error Cannot find DHCP a server or a group
002571 Error DHCP group already exists (name: <dhcpgroup_name>,
DHCP server: <dhcp_name>)
002572 Error Cannot find the DHCP server of failover channel
002573 Error DHCP failover channel already exists (name: <dhcpfail-
over_name>, DHCP name: <dhcp_name>, type: <dhcp-
failover_type>)
002574 Error Can't find DHCP server or shared network
002575 Error DHCP shared network already exists (name: <dh-
cpsn_name>, DHCP server: <dhcp_name>)
002576 Notice DHCP failover channel created (name: <dhcpfail-
over_name>, type: <dhcpfailover_type>, DHCP name:
<dhcp_name>)
002577 Error DHCP failover port already used (port: <port>, failover
channel name: <dhcpfailover_name>)
002578 Error DHCP server already used as secondary for a failover
channel (DHCP name: <dhcp_name>)

743
 Return Codes

Code Level Description

002579 Error Cannot set this DHCP server as secondary: it is already
used (DHCP name: <dhcp_name>)
002580 Error Can only create shared network on EfficientIP DHCP
(DHCP name: <dhcp_name>, type: <dhcp_type>)
002581 Error Can't find DHCP server or server option
002582 Error Can't find DHCP scope or scope option
002583 Error Can't find DHCP ACL or ACL option
002584 Error Can't find DHCP ACL data or ACL data option
002585 Error Can't find DHCP group or group option
002586 Error Can't find DHCP range or range option
002587 Error Can't find DHCP static or static option
002588 Error Can't find DHCP scope (address: <dhcpscope_addr>,
DHCP server: <dhcp_name>)
002589 Warning DHCP scope already deleted (address: <dhcpscope_ad-
dr>, DHCP server: <dhcp_name>)
002590 Error Can't find DHCP range (address: <dhcprange_addr>,
DHCP server: <dhcp_name>)
002591 Warning DHCP range already deleted (address: <dhcprange_ad-
dr>, DHCP server: <dhcp_name>)
002592 Error Can't find DHCP static (name: <dhcphost_name>, ad-
dress: <dhcphost_addr>, DHCP server: <dhcp_name>)
002593 Warning DHCP static already deleted (name: <dhcphost_name>,
address: <dhcphost_addr>, DHCP server: <dhcp_name>)
002594 Error Can't find DHCP ACL (name: <dhcpclass_name>, DHCP
server: <dhcp_name>)
002595 Warning DHCP ACL already deleted (name: <dhcpclass_name>,
DHCP server: <dhcp_name>)
002596 Error Can't find DHCP ACL data (value: <dhcpsubclass_value>,
ACL name: <dhcpclass_name>, DHCP server: <dh-
cp_name>)
002597 Warning DHCP ACL data already deleted (value: <dhcpsub-
class_value>, ACL name: <dhcpclass_name>, DHCP
server: <dhcp_name>)
002598 Error Can't find DHCP group (name: <dhcpgroup_name>, DH-
CP server: <dhcp_name>)
002599 Warning DHCP group already deleted (name: <dhcpgroup_name>,
DHCP server: <dhcp_name>)
002600 Error Can't find DHCP failover channel (name: <dhcpfail-
over_name>, DHCP server: <dhcp_name>)
002601 Warning DHCP failover channel already deleted (name: <dhcpfail-
over_name>, DHCP server: <dhcp_name>)
002602 Error Can't find DHCP server or option definition

744
 Return Codes

Code Level Description

002603 Error DHCP option definition already exists (Name: <dhcpop-
tiondef_name>, DHCP server: <dhcp_name>)
002604 Error Can't modify standard option definition (name: <dhcpop-
tiondef_name>)
002605 Error Can't delete standard option definition (name: <dhcpop-
tiondef_name>)
002606 Notice DHCP option definition correctly deleted (name: <dhcpop-
tiondef_name>, DHCP server: <dhcp_name>)
002607 Warning DHCP option definition already deleted (name: <dhcpop-
tiondef_name>, DHCP server: <dhcp_name>)
002608 Error Can't find DHCP option definition (name: <dhcpop-
tiondef_name>, DHCP server: <dhcp_name>)
002609 Error Can't modify used option definition (name: <dhcpop-
tiondef_name>)
002610 Error Can't delete used option definition (name: <dhcpop-
tiondef_name>)
002611 Error DHCP server name already exists (name: <dhcp_name>)
002612 Error Smart DHCP server cannot be used as secondary in fail-
over channel
002613 Error Scope overlap [<scope_name>]
002614 Error DHCP static not in scope (address: <dhcphost_addr>,
DHCP server: <dhcp_name>)
002615 Error Can't find DHCP server, scope or range
002616 Error Can't find DHCP lease
002617 Error Can't delete a children DHCP server
002618 Error Can't delete a SMART DHCP server with children
002619 Error To many DHCP servers selected
002620 Error Failover channel not configured for this DHCP server
002621 Error Range overlap [<dhcprange_name>]
002622 Error Too many failover channels set for this smart architecture
(DHCP smart server: <dhcp_name>, smart architecture:
<vdhcp_arch>)
002623 Error Can't delete a DHCP failover currently used by a DHCP
scope (Failover name: <dhcpfailover_name>)
002624 Error DHCP server address already exists (address: <hostad-
dr>)
002625 Error Can't change DHCP server name (name: <dhcp_name>)
002626 Error Can't change DHCP server type (from: <from>, to: <to>)
002627 Error Bad DHCP option format (option type: <optiondef_type>,
value: <optiondef_value>)
002628 Error Can't find this DHCP option definition on this server (option
name: <optiondef_name>, DHCP server: <dhcp_name>)
002629 Notice DHCP server created (name: <dhcp_name>)

745
 Return Codes

Code Level Description

002630 Notice DHCP group created (name: <dhcpgroup_name>)
002631 Notice DHCP lease created (name: <dhcplease_name>)
002632 Error DHCP server is in read-only mode (SMART DHCP
member)
002633 Error Invalid IP addresses (DHCP scope address: <dhcp-
scope_addr>, DHCP range address: <dhcprange_addr>)
002634 Error Specified DHCP scope size is invalid (too small).
002635 Error Line <line> could not be parsed
002636 Error Can't delete used ACL (<object_name>)
002637 Notice DHCP group deleted (name: <dhcpgroup6_name>)
002638 Notice DHCP failover channel deleted (name: <dhcpfail-
over6_name>)
002639 Notice DHCP option definition correctly deleted (name: <dhcpop-
tiondef6_name>, DHCP server: <dhcp6_name>)
002640 Notice DHCP range deleted
002641 Notice DHCP scope deleted (name: <dhcpscope6_name>)
002642 Notice DHCP static deleted (name: <dhcphost6_name>)
002643 Notice DHCP lease deleted (name: <dhcplease6_name>)
002644 Error Your DHCP server is in stateless mode
002645 Error Cannot change DHCP server into stateless mode, you
have to delete all ranges and statics first.
002646 Error DHCP Static is in range
003501 Error Access to request <request_id> is denied
003502 Error You're not administrator of request <request_name>
003503 Error Access denied
003509 Error This action is not possible on the selected request (<ac-
tion> <request_name>).
003510 Error Cannot reject request
003511 Error Cannot cancel request
003512 Error The request <request_name> can't be archived
003550 Notice Ticket <name_ticket> has been successfully changed
(<type_ticket>)
003600 Error You're not allowed to combine or divide a subnet re-
gistered to RIPE
003602 Error It is not allowed to combine subnets registered to RIPE
003603 Notice Adding send mail reactivate
003604 Notice Deletion send mail reactivate
003605 Notice Confirmation of overflow AW
003700 Error Bookmark already exists
003701 Error You cannot delete a bookmark that you do not own

746
 Return Codes

Code Level Description

003710 Error The Smart Folder already exists
003720 Error Gadget already exists
003721 Error You cannot delete a gadget that you don't own.
003722 Error This gadget cannot be deleted.
003723 Error You cannot modify a gadget that you don't own.
003724 Error This gadget cannot be modified.
003725 Error This gadget cannot be Visible to all users.
003730 Error The Quick Wizard already exists
003740 Error Alert already exists
003750 Error Graph already exist
003800 Error There is no other Active Management server found.
Therefore you can not switch this appliance to another
state. You first need to add a new Active Management
server.
003801 Error The selected member(s) could not be deleted because
the local management configured in RMAP can not be
alone.
005001 Error Subnet is not in a block
005002 Error Subnet overlap [<subnet_name>] (<subnet_start_ad-
dr>-<subnet_end_addr>)
005003 Error Block overlap [<block_name>]
005004 Error Can't find a subnet for that address
005005 Error Address already exists
005006 Error Reserved range not in a block
005007 Error Reserved range overlap [<range_name>]
005008 Error Pool overlap [<pool_name>]
005009 Error Pool is read only
005010 Error Can't delete default space
005011 Error Subnet already exists (address: <subnet_addr>, name:
<subnet_name>)
005012 Error Pool already exists
005013 Error Block already exists
005014 Error Name already exist as an alias
005015 Error Can't delete IP address in read only pool
005016 Error IP address does not exist
005017 Error Can't delete orphan addresses container
005018 Error Can't delete orphan subnets container
005019 Error Can't find a subnet for this pool
005020 Error Can't delete a space with children
005021 Error Can't delete a space with VLSM blocks

747
 Return Codes

Code Level Description

005022 Error Invalid subnet size
005023 Error The address and the size of the subnet are not coherent
005025 Error You can't split default subnet
005026 Error An identical IP address already exists in the destination
subnet
005027 Error A subnet in the destination space prevents the movement
005028 Error A pool in the destination space prevents the movement
005029 Error A subnet with the same IP address already exists in the
destination space
005030 Error A default subnet can't be migrated
005031 Error A VLSM subnet can't be migrated
005032 Error Multiple IP addresses match, you must first select a space
005033 Error The specified subnet does not exist
005034 Error Multiple subnets match : you must first select a space
005035 Error You can't split default block
005036 Error You can't split RIPE block
005037 Error You can't split a VLSM block
005038 Error You can't split this block, it creates a subnet overlap
005039 Error You can't migrate default block
005040 Error You can't migrate VLSM block
005041 Error You can't migrate block with VLSM subnet
005042 Error The block overlaps another block
005043 Error The target block is not empty a subnet already exists
005044 Error The target block is not empty, a pool already exists
005045 Error The target block is not empty, an address already exists
005046 Error The target subnet does not exist
005047 Error This address already exists in the target subnet
005048 Error <block_name> cannot be converted to VLSM (no parent
id)
005049 Error Critical error: could not query the database
005050 Error Could not find a free IP address
005051 Error You haven't selected a parent VLSM space
005052 Error The selected split value is too big
005053 Error Can't merge the selected subnets
005054 Error Can't split unmanaged subnets
005055 Error Can't merge unmanaged subnets
005056 Error Can't delete default space
005057 Notice Generated name: <name> (<hostaddr>)
005058 Error Can't change parent space using VLSM blocks

748
 Return Codes

Code Level Description

005059 Error Can't change parent space: space loop
005060 Error You must first select subnets
005061 Error Space name already exist
005062 Error Not enough free addresses for migration
005063 Error Can't find a space
005064 Error Permission denied to Add/Edit VLSM block
005065 Error Can't change block address or size
005066 Error Can't delete parent space (name: <site_name>)
005067 Error Can't find a block
005068 Error Can't find a space or a block
005069 Error Can't find a space or a subnet
005070 Error Can't find subnet
005071 Error Permission denied to delete VLSM block
005072 Error Can't unmanage a default subnet
005073 Error Can't find subnet or pool
005074 Error Can't find space or IP address
005075 Error Can't find IP address
005076 Error Can't find IP address or IP address alias
005077 Error IP address alias already exists
005078 Error Can't find IP address alias
005079 Error Permission denied to modify this space
005080 Error Permission denied to add a space without a parent space
005081 Error IP address overlaps another IP address in VLSM subnet
(address: <hostaddr>)
005082 Notice Subnet managed
005083 Notice Subnet unmanaged
005084 Error Cannot unmanage block
005085 Error Block already managed
005086 Error Subnet already managed
005087 Error Subnet already unmanaged
005088 Error Cannot unmanaged VLSM subnet
005089 Error Cannot create pool in VLSM subnet
005090 Error Cannot switch to terminal subnet, you have to delete pools
first
005091 Error Cannot switch to VLSM subnet, you have to delete pools
first
005092 Error The block you are creating overlaps assigned IP ad-
dresses (blocks) from two or more lower spaces.
005093 Error The block you are creating overlaps assigned IP ad-
dresses (blocks) from the lower space. Please release IP

749
 Return Codes

Code Level Description

addresses from the lower space before creating your
block.
005094 Error The block you are creating overlaps assigned IP ad-
dresses (subnets) from the lower space. Please release
IP addresses from the lower space before creating your
block.
005095 Error Impossible to create this space because the selected
parent space is terminal.
005096 Error The block you are creating overlaps assigned IP ad-
dresses (blocks) from the upper space. Please release
IP addresses from the upper space before creating your
block.
005097 Error The block you are creating overlaps assigned IP ad-
dresses (subnets) from the upper space. Please release
IP addresses from the upper space before creating your
block.
005098 Error Can't change subnet address or size
005099 Error You haven't select a VLSM space
005100 Warning IP address name already used. DNS and DHCP configur-
ations based on this name can be impacted (Space:
<site_name>, Address: <ip_addr>)
005101 Warning MAC address already used. (Space: <site_name>, Ad-
dress: <ip_addr>)
005102 Error Permission denied to create object in a template space
005103 Warning The block you are creating overlaps assigned IP ad-
dresses (blocks) from the upper space.
005104 Warning The block you are creating overlaps assigned IP ad-
dresses (subnets) from the upper space.
005105 Warning The block you are creating overlaps assigned IP ad-
dresses (blocks) from two or more lower spaces.
005106 Warning The block you are creating overlaps assigned IP ad-
dresses (blocks) from the lower space.
005107 Warning The block you are creating overlaps assigned IP ad-
dresses (subnets) from the lower space.
005501 Error Subnet is not in block
005502 Error Subnet overlap [<subnet6_name>] (<subnet6_start_ad-
dr>-<subnet6_end_addr>)
005503 Error Block overlap [<block6_name>]
005504 Error Can't find a subnet for that address
005505 Error Address already exists
005506 Error Reserved range not in a block
005507 Error Reserved range overlap [<range6_name>]
005508 Error Pool overlap [<pool6_name>]
005509 Error Pool is read only

750
 Return Codes

Code Level Description

005511 Error Subnet already exists
005512 Error Pool already exists
005513 Error Block already exists
005514 Error Name already exist as an alias
005515 Error Can't delete IP address in read only pool
005518 Error Can't delete orphan subnets container
005519 Error Can't find a subnet for the pool
008000 Error No SNMP Agent answered on <hostaddr>
008001 Notice Network device <hostaddr> refreshed (<name>)
008002 Notice Network device imported (address: <hostaddr>)
008003 Error Invalid/Missing parameter [selected_query/selected_oids]
008004 Notice Network device deleted
008005 Notice Interconnection port forced to yes
008006 Notice Interconnection port autodetected
008007 Notice Port modified
008008 Notice Port status modified
008009 Notice MAC addresses purged
008010 Error Network device does not exist
008011 Error Network device already exists
008012 Error Network device port already exists
008013 Error Cannot find group or network
008014 Warning The network device (<hostaddr>) is already associated
with the selected Target space
009000 Notice Object deleted (<type>)
009001 Error Unknown action
010000 Notice Can't connect to LDAP server
010001 Error Custom data already exists
010002 Error Custom database is in read-only
010003 Error Custom database already exists
011001 Error The report data is not valid
011002 Error The report file is not valid
011003 Error The report format is not valid
011004 Error The report extension is not valid
011005 Error Can't open report file
011006 Error You must first select reports
013000 Error Can't delete local member
013001 Error Member is not local
013002 Error Member is in another HA group
013003 Error Local member have no IP address configured

751
 Return Codes

Code Level Description

013004 Error Too many HA members configured
013005 Error Can't switch remote SOLIDserver to Hot Standby: local
database is Read-Only
013006 Error Can't switch local SOLIDserver to Hot Standby
013007 Error Member already exists
022100 Error Can't read file '<file>'
022101 Error Archive file is unreadable, and may be corrupted
022102 Error Can't find file '<file>'
022103 Error Invalid domain name: <value> (<file> line <line>)
022104 Error Invalid TTL value (<file> line <line>)
022105 Error Invalid RR type (<file> line <line>)
022106 Error Unsupported file format (<extension>)
022107 Error Missing value (<param>)
022108 Error Invalid zone name
022109 Error No master server specified for zone <name>
022110 Error Invalid value (<param> <value>)
022111 Error Invalid address
022112 Error IP address is outside a block, subnet or pool
022113 Error Size must be greater than zero
022114 Error Missing address
022115 Error Range is outside scope
022116 Error Pool is outside block or subnet
022117 Error Subnet is outside block
022118 Error Invalid MAC address (<value>)
022119 Error Size is too long (<param> : )
022120 Error The RR is not in the current zone.
022121 Error Incorrect values: "<dump>"
022200 Error The column is not present in the CSV file
022201 Error A mandatory parameter (<param>) is missing
022202 Error Invalid DHCP option code (<code>)
022203 Error Invalid client identifier <client_ident>)
022204 Error No DHCP static identifier
022205 Error Bad name format for static "<static_name>"
035000 Notice IP address correctly imported
035001 Notice IP address (v6) correctly imported
035002 Notice Block correctly imported (<block_name>)
035003 Notice Block (v6) correctly imported
035004 Notice Range correctly imported
035005 Notice Group correctly imported

752
 Return Codes

Code Level Description

035006 Notice Pool correctly imported
035007 Notice Pool (v6) correctly imported
035008 Notice RR correctly imported
035009 Notice Scope correctly imported
035010 Notice Space correctly imported
035011 Notice Static correctly imported
035012 Notice Subnet correctly imported
035013 Notice Subnet (v6) correctly imported
035014 Notice User correctly imported
035015 Notice Zone correctly imported
035016 Notice IP address and alias correctly imported
035017 Notice RR correctly checked
035018 Notice Zone correctly checked (<dnszone_name>)
035019 Notice Line is correct
035020 Notice Custom data correctly imported
035021 Notice Finished importing MS DHCP configuration.
035100 Warning Ignoring all SOA
035101 Warning Zone [<name>] empty (no file associated)
035102 Warning Object not following RFC 1034
035103 Warning Root zones are not handled.
035200 Warning Multiple sizes have been specified in CSV file
035201 Warning Not prefix given, find one appropriate using the starting
address of the scope
036000 Notice Package <package> version <version> correctly created
036001 Error Can't read contents file
036002 Error Could not change directory
036003 Error Can't create contents file
036004 Notice Package <package> version <version> correctly deleted
036005 Notice Package <package> version <version> correctly installed
036006 Error Package does not exist
036007 Error Can't delete an installed package (package <package>
version <version>)
036008 Notice Package <package> version <version> correctly unin-
stalled
036009 Notice Package <package> version <version> correctly uploaded
036010 Error Package <package> version <version> already installed
036011 Error Package <package> version <version> already uninstalled
036012 Error A package with the same name is already installed
(package <package>)

753
 Return Codes

Code Level Description

036013 Error The file <file> in the package <source_package> version
<source_version> is already installed by the package
<installed_package> version <installed_version>
036014 Error Package <package> version <version> already exists
036015 Warning The file <file> you want to add does not exist
037000 Notice RR correctly copied
037001 Notice RR correctly migrated
038000 Notice IP address successfully migrated
038001 Notice Subnet successfully migrated
038002 Notice Block correctly split
038003 Notice Block correctly migrated
038004 Notice Subnet correctly migrated
038005 Notice Pool correctly migrated
038006 Notice Address correctly migrated
038007 Notice Old block correctly deleted
038008 Notice Old subnet correctly deleted
038009 Notice Old pool correctly deleted
038010 Notice Old address correctly deleted
038011 Notice IP address correctly migrated
038012 Notice Old address correctly deleted
038013 Notice Space deleted (name: <site_name>)
038014 Notice Block deleted (name: <block_name>)
038015 Notice Subnet deleted (name: <subnet_name>)
038016 Notice Pool deleted (name: <pool_name>)
038017 Notice IP address deleted (space: <site_name>, block:
<block_name>, subnet: <subnet_name>, address:
<ip_addr>, name: <name>)
038018 Notice The block <block_name> is already a VLSM
038019 Notice VLSM block created (name: <block_name>)
038020 Notice Created block <block_name>
038021 Notice Subnet <subnet_name> created
038022 Notice Pool <pool_name> created
038023 Notice Address <ip_name> created
038024 Notice Address alias <ip_name> created
038025 Notice IP address name modified to <ip_name>
038026 Notice No changed required on that IP address
038027 Notice IP address deleted (space: <site_name>, block:
<block6_name>, subnet: <subnet6_name>, address:
<ip6_addr>, name: <ip6_name>)
038028 Notice Space <site_name> created

754
 Return Codes

Code Level Description

038029 Notice Address created
038030 Notice Subnet created
038031 Notice Block created
038100 Warning Errors preventing the migration of the subnet
039000 Notice ACL name correctly add to DHCP static class parameters
039001 Notice Static MAC address correctly added to ACL Data
040000 Notice There is not enough space to add this file
040001 Notice Max limit reached on this item
045000 Notice Device deleted
045001 Notice Device added
045002 Notice Device modified
045003 Notice Interface deleted
045004 Notice Interface added
045005 Notice Interface modified
045006 Notice Type deleted
045007 Notice Type added
045008 Error Device doesn't exist
045009 Error Interface doesn't exist
045010 Error Type doesn't exist
045011 Error Type is used
045012 Error Device already exists
045013 Error Interface already exists
045014 Error Type already exists
045015 Error Device name already exists
045016 Error MAC address already exists
045017 Notice Device imported
045018 Notice Interface imported
045019 Notice Type imported
045020 Notice Device name modified
045021 Error Invalid MAC address
045022 Notice Interface managed
045023 Notice Interface unmanaged
050001 Error The IP address overlaps another IP address
050002 Error Virtual IP is not contain in any interface
050003 Error IP address already used on interface
050004 Notice SNMP community modified
050005 Notice Ports configuration modified
050006 Notice Traps configuration modified

755
 Return Codes

Code Level Description

050007 Notice Date modified
050008 Notice SMTP configuration modified
050009 Notice Versions modified
050010 Notice Firewall configuration modified
050011 Notice SNMP v3 configuration modified
050012 Notice Virtual IP configuration modified
050013 Notice Global configuration modified
050014 Notice SSH password modified
050015 Notice Static route modified
050016 Notice Interface modified
050018 Error Community already exists
050019 Error Community does not exist
050020 Error Community restriction already set
050021 Error Community restriction not set
050022 Error Domain name already exists
050023 Error Domain name does not exist
050024 Error Domain name not valid
050025 Error IP address used twice: <ip_addr>
050026 Error Firewall failure
050027 Error Can't add a 802.1q interface for an ethernet port failover
050028 Error Internal failure
050029 Error Invalid domain
050030 Error Invalid hostname
050031 Error Invalid IP address
050032 Error Invalid parameter
050033 Error Invalid preference
050034 Error Invalid protocol: <protocol>
050035 Error Invalid rule number
050036 Error IP address not valid
050037 Error Media not supported
050038 Error Missing file rights
050039 Error Server name already exists
050040 Error Server name does not exist
050041 Error Cant add a 802.1q interface for an ethernet port failover
050042 Error Interface doesn't exist
050043 Error Interface is not a valid aggregate
050044 Error Interface already aggregated
050045 Error Interface does not exist

756
 Return Codes

Code Level Description

050046 Error Interface is not aggregated
050047 Error Interface is not a 802.1q
050048 Error Interface is a 802.1q
050049 Error NTP server already exists
050050 Error NTP server does not exist
050051 Error Password too short
050052 Error Physical interface does not exist
050053 Error Rule already exists
050054 Error Rule doesn't exist
050055 Error Service can't be disable
050056 Error Service does not exist
050057 Error Service does not have a virtual IP address
050058 Error Service does not support virtual IP addresses
050059 Error Service failed to start (<err>)
050060 Error Service has no snmpd
050061 Error Missing configuration for snmpd service
050062 Error Host already exists
050063 Error Host does not exist
050064 Error User already exists
050065 Error User doesn't exist
050066 Error Interface already exists
050067 Error Interface doesn't exist
050068 Error Failed to read system configuration
050069 Error Failed to read configuration from file
050070 Error Failed to write destination file
050071 Notice Configuration applied
050072 Error SSH password too short
050073 Error SSH passwords are not equals
050074 Error Service failed to stop
050075 Notice Configuration cancelled
050076 Notice Added LAGG successful
050077 Notice Deletion of LAGG successful
050078 Notice Successfully added a firewall rule.
050079 Notice Deletion of firewall rule successful
050080 Error You can't add CARP service when there is no configured
interface
050081 Error You can't delete IP address when it's linked with CARP
service
050082 Error Could not generate a TAR archive.

757
 Return Codes

Code Level Description

050083 Notice Successfully generated debug information in the local
directory. File: <file_name>
050084 Error Could not create a debug file to hold the results of the
commandline tests (check the permissions and/or the free
disk space of "/tmp").
050085 Notice The status of the firewall has been modified
050086 Notice Successfully modified the firewall rule.
050087 Notice Behavior of the firewall successfully altered.
050088 Notice Gateway modified.
050089 Error Cannot alter protected rules (position < 100 or = 65535).
050090 Notice Hostname modified.
050091 Notice DNS resolvers modified.
050092 Notice SmartHost relay modified.
050093 Error The process NTPD is not running.
050094 Error No NTP reference server configured.
050095 Error Unknown error while synchronizing NTP.
050096 Error Unknown error while configuration the CARP interface.
050097 Error The CARP interface could not be attached to any existing
IP subnet. You must firstly configure a classical IP ad-
dress.
050098 Error Conflicting VLAN tags.
050099 Error Could not modify the system date.
050100 Notice The SSH password was successfully changed.
050101 Notice SNMP configuration updated.
050102 Error A VIF with the same name already exists.
050103 Notice Modifications discarded.
050104 Error Missing the default gateway.
050105 Error Missing port configuration for the SNMP agent.
050106 Error Couldn't delete the virtual interface: there is IP addresses
configured.
050107 Warning Virtual interface deleted.
050108 Error Cannot modify a protected rule.
050109 Error The gateway is not located in any configured IP subnet.
050110 Error You must specify at least one DNS resolver.
050111 Error You can't delete a certificate which is used by a service
(service: <object_name>).
050112 Notice SNMP configuration modified.
050113 Error Can't create a virtual interface with no physical interfaces
attached to it.
050114 Notice NTP updated the date of the server using the NTP located
at <server>.

758
 Return Codes

Code Level Description

050115 Warning NTP was not able to synchronize with <server> (message:
<message>)
050116 Error No suitable servers were found. Could not update the
date of the system.
050117 Error The service <service> is disabled, cannot start it.
050118 Error Same VHID is used in more than one service
050119 Error A unique VHID cannot contain CARP addresses on differ-
ent subnets.
050120 Error This is not a leap year.
050121 Error File <file> not found.
050122 Error The directory <file> cannot be deleted.
050123 Error File format not authorized. Please remove character ',' in
your name file.
050124 Warning Impossible to give the same name to an IPv4 and an IPv6
static route.
050125 Error Cannot mix V4/V6 IP addresses for from and to fields
050126 Error A static route gateway is not located in any configured IP
subnet.
050127 Error No IP address configured.
050128 Error You need to specify at least one IPv4 address if you set
an IPv4 gateway.
050129 Error You need to specify at least one IPv6 address if you set
an IPv6 gateway.
050130 Error You cannot enable or start the service <service> when
the service <exclude> is enabled
051000 Error Impossible to edit files that are not in Class Studio format
051017 Error You can not add class using the name "global" or "default"
(reserved name)
051018 Error You can not delete class using the name "global" or "de-
fault" (reserved class)
051019 Error The name of class file is already used
051020 Error Class file can not be disabled
051021 Error Moving "default" or "global" class files is forbidden
051022 Error Class file can not be enabled - Already enabled
051023 Error Could not find class "<class_name>", please ensure that
this class file exists.
052000 Error Could not connect to the Microsoft service. Please check
the IP address and the port the service is listening on.
052001 Error The Microsoft server didn't provide the expected informa-
tion (protocol = <protocol> ; boot time = <boot_time>)
052002 Error Could not create the given DNS resource record (name:
<rr_name>)

759
 Return Codes

Code Level Description

052003 Error Could not delete the specified DNS resource record
(name: <rr_name>)
052004 Error Could not update the options of the Microsoft DNS server
(operation that failed: <operation_name>).
052005 Error Wrong or missing credentials.
052011 Error Generic Microsoft service fault. Check the event log of
the Microsoft service.
052012 Error Microsoft internal error: null reference exception. Please
contact EfficientIP.
052013 Error (internal) Zone already exists.
052014 Error Invalid zone parameters.
052015 Error Zone does not exist.
052016 Error Nothing to modify on the zone.
052020 Error Could not connect to the WinDNS service (using SSL:
<ssl> // Server: <host_addr>:<port> // Error: "<errmsg>"
).
052021 Error Could not gather data of the server.
052022 Error DNS server not referenced (id = <dns_id>).
052023 Error Missing or invalid DNS zone ID.
052024 Error Could not delete DNS zone "<dnszone_name>".
052025 Error Could not retrieve zones list: <errmsg>.
052026 Error Couldn't synchronize the zone "<dnszone_name>". Error:
<errmsg>.
052027 Error Could not create zone "<dnszone_name>". Error: <er-
rmsg>.
052028 Error Unsupported zone type.
052040 Warning Could not retrieve statistics from Microsoft service.
052041 Warning Could not retrieve Microsoft version (check the connection
parameters).
052042 Warning Could not retrieve the information of the zone
<dnszone_name>.
052043 Warning Automatically switching to a NO SECURITY policy on
zone transfers
052050 Notice Successfully created resource record "<rr_name>".
052051 Notice Successfully deleted the resource record "<rr_name>".
052052 Notice Updated Microsoft server configuration (recursion: <recur-
sion> // global forwarders: <forwarders>).
052053 Notice DNS zones up-to-date.
052054 Notice Successfully deleted DNS zone "<dnszone_name>".
052055 Notice DNS zone "<dnszone_name>" successfully synchronized.
052056 Notice Microsoft server version updated to version "<version>".

760
 Return Codes

Code Level Description

052057 Notice Microsoft server is up and running.
052058 Notice Synchronization is complete
052100 Error Could not connect to server <host_addr>:<port> (using
SSL: <ssl>) . Error message: <errmsg>
052101 Error Could not get the status of the server
052102 Error Generic synchronization error (line received: <text>)
052103 Error The lease timestamp is incorrect: the lease will be ignored.
052125 Warning Server option not properly decoded: code = <op-
tion_code> name = <option_name> type = <option_type>
MS option = <ms_to_ms_option_value> IPM option =
<ms_to_ipm_option_value> Vendor option = <op-
tion_vendor>
052126 Warning Could not find option <dhcpoption_name>
052127 Warning Could not find scope option <dhcpoption_name>
052128 Warning Could not find static option <dhcpoption_name>
052150 Notice Updated WinDHCP version to <version>
052151 Notice Added <obj_name> (<obj_type>) from vendor <vendor>
to the server option definitions
052152 Notice Deleted the static <hostname> because it has no IP asso-
ciated with it
052153 Notice Flushing delayed delete IP
052154 Notice The DHCP server (<host_addr>) is synchronized (boot
time = <boot_time> // serial = <serial> // leases =
<lease_counter>)
052155 Notice Server option <dhcpoption_name> deleted
052156 Notice Server option <dhcption_name> modified on SOLIDserver
("<ms_to_ms_option_value>" to "<ipm_to_ms_op-
tion_value>")
052157 Notice Server option <dhcption_name> modified on MS
("<ipm_to_ipm_option_value>" to "<ms_to_ipm_op-
tion_value>")
052158 Notice Created server option <dhcpoption_name> on MS
(value="<ipm_to_ms_option_value>")
052159 Notice Server option <dhcpoption_name> ("<ms_to_ipm_op-
tion_value>") created in SOLIDserver
052160 Notice Server option <dhcpoption_name> deleted in SOLIDserver
052161 Notice Scope <dhcpscope_net_addr> modified in MS
052162 Notice Scope <dhcpscope_net_addr> deleted in MS
052163 Notice Scope <dhcpscope_net_addr> modified in SOLIDserver
052164 Notice Scope <dhcpscope_net_addr> created in SOLIDserver
052165 Notice Scope <dhcpscope_net_addr> created in MS
052166 Notice Scope <dhcpscope_net_addr> deleted in SOLIDserver

761
 Return Codes

Code Level Description

052167 Notice Delete scope option <dhcpoption_name> on <dhcp-
scope_net_addr> in MS
052168 Notice Scope option <dhcpoption_name> modified on <dhcp-
scope_net_addr> ("<ipm_to_ms_option_value>") in MS
052169 Notice Scope option <dhcpoption_name> modified on <dhcp-
scope_net_addr> in SOLIDserver ("<ipm_to_ipm_op-
tion_value>" to "<ipm_to_ms_option_value>")
052170 Notice Scope option <dhcpoption_name> ("<ms_to_ipm_op-
tion_value>") created on <dhcpscope_net_addr> in
SOLIDserver
052171 Notice Scope option <dhcpoption_code> created on <dhcp-
scope_net_addr> in MS
052172 Notice Scope option <dhcpoption_code> deleted on <dhcp-
scope_net_addr> in SOLIDserver
052173 Notice Range <range_start_ip_addr> - <range_end_ip_addr>
modified in scope <dhcpscope_net_addr> in MS
052174 Notice Range <range_start_ip_addr> - <range_end_ip_addr>
deleted in scope <dhcpscope_net_addr> in MS
052175 Notice Range <range_start_ip_addr> - <range_end_ip_addr>
deleted from scope <dhcpscope_net_addr> in SOLIDserv-
er
052176 Notice Range <range_start_ip_addr> - <range_end_ip_addr>
created in scope <dhcpscope_net_addr> in SOLIDserver
052177 Notice Range <range_start_ip_addr> - <range_end_ip_addr>
created in scope <dhcpscope_net_addr> in MS
052178 Notice Static <static_addr> modified in MS
052179 Notice Static <static_addr> modified in SOLIDserver
052180 Notice Static <static_addr> deleted in MS
052181 Notice Static <static_addr> deleted in SOLIDserver
052182 Notice Static <static_addr> created in SOLIDserver
052183 Notice Static <static_addr> created in MS
052184 Notice Static option <dhcpoption_name> deleted on <static_ad-
dr> in MS
052185 Notice Static option <dhcpoption_code> deleted on <static_addr>
in SOLIDserver
052186 Notice Static option <dhcpoption_name> modified
("<ipm_to_ms_option_value>") on <static_addr> in MS
052187 Notice Static option <dhcpoption_name> modified on <static_ad-
dr> in SOLIDserver ("<ipm_to_ipm_option_value>" to
"ms_to_ipm_option_value")
052188 Notice Static option <dhcpoption_name> created
("<ms_to_ipm_option_value>") on <static_addr> in
SOLIDserver

762
 Return Codes

Code Level Description

052189 Notice Static option <dhcpoption_name> created
("<ipm_to_ms_option_value>") on <static_addr> in MS
052200 Error Could not locate snmpwalk binary
052201 Error Could not execute snmpwalk command ("<cmd>"). Error:
<err>
052202 Error Could not launch tcpdump process (command: "<cmd>")
052220 Notice Dump finished
052221 Notice Captured info about VLAN <vlan>
052300 Error Could not connect to the remote Microsoft server (IP:
<ip>).
053000 Error The minimum size for encryption is 384 bits.
053001 Error Could not generate DSA parameters for the key.
053002 Error Could not generate a DSA key.
053003 Error Could not generate the CSR file.
053004 Error A key file is missing in the imported archive.
053005 Error The selected SSL certificate is not usable.
053200 Notice The Key Ring object <object_name> has been success-
fully deleted.
053201 Notice Private key successfully created.
053202 Notice CSR successfully created.
053203 Notice Public key successfully created.
053204 Notice Self signed certificate successfully created.
053205 Notice Certificate applied.
053206 Notice The key <key_name> was successfully invalidated.
053250 Error Could not generate requested DNSSEC key. Following
output was sent: <parameters>
053251 Error Could not fetch key content (<parameters>)
053252 Error Could not find DNSSEC key !
053253 Error Could not update key metadata, key malformed.
053254 Error Could not find the corresponding key.
053255 Error Cannot edit / delete DNSSEC keys.
053256 Error Cannot sign zone <dnszone_name>, only master zones
can be signed.
053257 Error Key <key_name> was already revoked.
053258 Error The key <key_name> has already been deactivated.
053259 Error The key <key_name> has already been activated.
053260 Error This key <key_name> was invalidated. Please disable it
first before enabling the new one.
053261 Error Cannot revoke the key <key_name>, it is currently dis-
abled.

763
 Return Codes

Code Level Description

053262 Error Cannot purge zone <dnszone_name>, it is still marked
as used with DNSSEC.
053263 Error The specified DNSKEY already exists.
053264 Error The zone <dnszone_name> was already signed for
DNSSEC.
053265 Error Cannot change DNS server type, this server currently
serves DNSSEC signed zones.
053266 Error Cannot change DNS server type, this server is currently
configured to resolve DNSSEC zones.
053267 Error Cannot directly delete DNSSEC-related records.
053268 Error Cannot delete last anchor, at least 1 must be specified.
053269 Error Cannot delete <object_name>, as it is currently used by
the system.
053270 Error It's impossible to delete KSKs. Please use the options of
the Expert menu instead.
053271 Error You must select at least 1 DNSSEC key.
053272 Error Cannot invalidate the key <key_name>, only KSK keys
can be invalidated.
053273 Error Cannot enable the out-of-date key "<key_name>".
053274 Error Cannot add Trust Anchor from invalidated KSK
053275 Error Can enable/disable KSK/ZSK keys only.
053276 Error This DNS server (<dns_name>) is already resfreshing.
053277 Error This action cannot be performed on non-signed DNS
zones (zone: <dnszone_name>).
053278 Error The minimal allowed validity for DNSSEC keys is 3 days.
053279 Error Could not delete the DNSSEC key from the HSM
053280 Error You cannot set the validity to <count> days. The date
range cannot exceed the year 2037.
054000 Error Label already exists
055000 Warning Some conflict detected
055001 Warning To commit use <cmd>
055002 Error Commit failed
055003 Error File conflict

764