Skip to content

Commit ca0d0ec

Browse files
author
Anusha Hegde
committed
differentiating required and optional arguments in the help text for vmc samples
1 parent c65019f commit ca0d0ec

25 files changed

+139
-125
lines changed

‎samples/vmc/networks_nsxt/cgw_firewall_crud.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,19 @@ def __init__(self):
3939
parser = argparse.ArgumentParser(
4040
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
4141

42-
parser.add_argument('--refresh_token',
42+
required_args = parser.add_argument_group('required arguments')
43+
44+
required_args.add_argument('--refresh_token',
4345
required=True,
4446
help='Refresh token obtained from CSP')
4547

46-
parser.add_argument('--org_id',
48+
required_args.add_argument('--org_id',
4749
required=True,
4850
help='Orgization ID')
4951

50-
parser.add_argument('--sddc_id',
52+
required_args.add_argument('--sddc_id',
5153
required=True,
52-
help='Sddc ID')
54+
help='SDDC ID')
5355

5456
args = parser.parse_args()
5557

‎samples/vmc/networks_nsxt/dfw_firewall_crud.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,19 @@ def __init__(self):
4141
parser = argparse.ArgumentParser(
4242
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
4343

44-
parser.add_argument('--refresh_token',
44+
required_args = parser.add_argument_group('required arguments')
45+
46+
required_args.add_argument('--refresh_token',
4547
required=True,
4648
help='Refresh token obtained from CSP')
4749

48-
parser.add_argument('--org_id',
50+
required_args.add_argument('--org_id',
4951
required=True,
5052
help='Orgization ID')
5153

52-
parser.add_argument('--sddc_id',
54+
required_args.add_argument('--sddc_id',
5355
required=True,
54-
help='Sddc ID')
56+
help='SDDC ID')
5557

5658
args = parser.parse_args()
5759

‎samples/vmc/networks_nsxt/hello_world.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,19 @@ class AuthExample(object):
3535
def __init__(self):
3636
parser = argparse.ArgumentParser(
3737
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
38-
parser.add_argument('-r', '--refresh-token',
38+
39+
required_args = parser.add_argument_group('required arguments')
40+
required_args.add_argument('-r', '--refresh-token',
3941
required=True,
4042
help='VMware Cloud API refresh token')
4143

42-
parser.add_argument('-o', '--org-id',
44+
required_args.add_argument('-o', '--org-id',
4345
required=True,
4446
help='Organization identifier.')
4547

46-
parser.add_argument('-s', '--sddc-id',
48+
required_args.add_argument('-s', '--sddc-id',
4749
required=True,
48-
help='Sddc Identifier.')
50+
help='SDDC Identifier.')
4951

5052
args = parser.parse_args()
5153

‎samples/vmc/networks_nsxt/l3_vpn_crud.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,24 @@ def __init__(self):
4242
parser = argparse.ArgumentParser(
4343
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
4444

45-
parser.add_argument('--refresh_token',
45+
required_args = parser.add_argument_group('required arguments')
46+
required_args.add_argument('--refresh_token',
4647
required=True,
4748
help='Refresh token obtained from CSP')
4849

49-
parser.add_argument('--org_id',
50+
required_args.add_argument('--org_id',
5051
required=True,
5152
help='Orgization ID')
5253

53-
parser.add_argument('--sddc_id',
54+
required_args.add_argument('--sddc_id',
5455
required=True,
55-
help='Sddc ID')
56+
help='SDDC ID')
5657

57-
parser.add_argument('--remote_endpoint_public_ip',
58+
required_args.add_argument('--remote_endpoint_public_ip',
5859
required=True,
5960
help='L3 VPN Remote end point\'s public ip')
6061

61-
parser.add_argument('--passphrase',
62+
required_args.add_argument('--passphrase',
6263
required=True,
6364
help='Passphrase used for VPN')
6465

‎samples/vmc/networks_nsxt/nat_crud.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,18 @@ def __init__(self):
3939
parser = argparse.ArgumentParser(
4040
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
4141

42-
parser.add_argument('--refresh_token',
42+
required_args = parser.add_argument_group('required arguments')
43+
required_args.add_argument('--refresh_token',
4344
required=True,
4445
help='Refresh token obtained from CSP')
4546

46-
parser.add_argument('--org_id',
47+
required_args.add_argument('--org_id',
4748
required=True,
4849
help='Orgization ID')
4950

50-
parser.add_argument('--sddc_id',
51+
required_args.add_argument('--sddc_id',
5152
required=True,
52-
help='Sddc ID')
53+
help='SDDC ID')
5354

5455
args = parser.parse_args()
5556

‎samples/vmc/networks_nsxt/security_group_create.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,24 @@
3838
parser = argparse.ArgumentParser(
3939
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
4040

41-
parser.add_argument('--refresh_token',
41+
required_args = parser.add_argument_group('required arguments')
42+
required_args.add_argument('--refresh_token',
4243
required=True,
4344
help='Refresh token obtained from CSP')
4445

45-
parser.add_argument('--org_id',
46+
required_args.add_argument('--org_id',
4647
required=True,
4748
help='Orgization ID')
4849

49-
parser.add_argument('--sddc_id',
50+
required_args.add_argument('--sddc_id',
5051
required=True,
5152
help='Sddc ID')
5253

5354
parser.add_argument('--gateway_type',
5455
default='mgw',
5556
help='Gateway type. Either mgw or cgw')
5657

57-
parser.add_argument('--name',
58+
required_args.add_argument('--name',
5859
required=True,
5960
help='Name of the security group to be created')
6061

‎samples/vmc/networks_nsxt/security_group_delete.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,18 @@
4242
parser = argparse.ArgumentParser(
4343
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
4444

45-
parser.add_argument('--refresh_token',
45+
required_args = parser.add_argument_group('required arguments')
46+
required_args.add_argument('--refresh_token',
4647
required=True,
4748
help='Refresh token obtained from CSP')
4849

49-
parser.add_argument('--org_id',
50+
required_args.add_argument('--org_id',
5051
required=True,
5152
help='Orgization ID')
5253

53-
parser.add_argument('--sddc_id',
54+
required_args.add_argument('--sddc_id',
5455
required=True,
55-
help='Sddc ID')
56+
help='SDDC ID')
5657

5758
parser.add_argument('--gateway_type',
5859
default='mgw',

‎samples/vmc/networks_nsxt/security_group_list.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,18 @@
3737
parser = argparse.ArgumentParser(
3838
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
3939

40-
parser.add_argument('--refresh_token',
40+
required_args = parser.add_argument_group('required arguments')
41+
required_args.add_argument('--refresh_token',
4142
required=True,
4243
help='Refresh token obtained from CSP')
4344

44-
parser.add_argument('--org_id',
45+
required_args.add_argument('--org_id',
4546
required=True,
4647
help='Orgization ID')
4748

48-
parser.add_argument('--sddc_id',
49+
required_args.add_argument('--sddc_id',
4950
required=True,
50-
help='Sddc ID')
51+
help='SDDC ID')
5152

5253
parser.add_argument('--gateway_type',
5354
default='mgw',

‎samples/vmc/networks_nsxt/security_group_update.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,18 @@
4343
parser = argparse.ArgumentParser(
4444
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
4545

46-
parser.add_argument('--refresh_token',
46+
required_args = parser.add_argument_group('required arguments')
47+
required_args.add_argument('--refresh_token',
4748
required=True,
4849
help='Refresh token obtained from CSP')
4950

50-
parser.add_argument('--org_id',
51+
required_args.add_argument('--org_id',
5152
required=True,
5253
help='Orgization ID')
5354

54-
parser.add_argument('--sddc_id',
55+
required_args.add_argument('--sddc_id',
5556
required=True,
56-
help='Sddc ID')
57+
help='SDDC ID')
5758

5859
parser.add_argument('--gateway_type',
5960
default='mgw',
@@ -62,7 +63,7 @@
6263
parser.add_argument('--group_id',
6364
help='ID of the group to be updated')
6465

65-
parser.add_argument('--name',
66+
required_args.add_argument('--name',
6667
required=True,
6768
help='New name of the security group to be updated')
6869

‎samples/vmc/networks_nsxt/segments_firewall_crud.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,18 @@ def __init__(self):
3737
parser = argparse.ArgumentParser(
3838
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
3939

40-
parser.add_argument('--refresh_token',
40+
required_args = parser.add_argument_group('required arguments')
41+
required_args.add_argument('--refresh_token',
4142
required=True,
4243
help='Refresh token obtained from CSP')
4344

44-
parser.add_argument('--org_id',
45+
required_args.add_argument('--org_id',
4546
required=True,
4647
help='Orgization ID')
4748

48-
parser.add_argument('--sddc_id',
49+
required_args.add_argument('--sddc_id',
4950
required=True,
50-
help='Sddc ID')
51+
help='SDDC ID')
5152

5253
args = parser.parse_args()
5354

‎samples/vmc/networks_nsxv/dns_crud.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,25 +33,27 @@ class DNSCrud(object):
3333
def __init__(self):
3434
parser = argparse.ArgumentParser(
3535
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
36-
parser.add_argument('-r', '--refresh-token',
36+
37+
required_args = parser.add_argument_group('required arguments')
38+
required_args.add_argument('--refresh-token',
3739
required=True,
3840
help='VMware Cloud API refresh token')
3941

40-
parser.add_argument('-o', '--org-id',
42+
required_args.add_argument('--org-id',
4143
required=True,
4244
help='Organization identifier.')
4345

44-
parser.add_argument('-s', '--sddc-id',
46+
required_args.add_argument('--sddc-id',
4547
required=True,
46-
help='Sddc Identifier.')
48+
help='SDDC Identifier.')
4749

4850
parser.add_argument('--use-compute-gateway',
4951
action='store_true',
5052
default=False,
5153
help='Use compute gateway. Default is using '
5254
'management gateway')
5355

54-
parser.add_argument('-c', '--cleardata',
56+
parser.add_argument('--cleardata',
5557
action='store_true',
5658
help='Clean up after sample run')
5759
args = parser.parse_args()

‎samples/vmc/networks_nsxv/expose_public_ip.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,19 @@ class ExposePublicIP(object):
3838
def __init__(self):
3939
parser = argparse.ArgumentParser(
4040
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
41-
parser.add_argument('-r', '--refresh-token',
41+
42+
required_args = parser.add_argument_group('required arguments')
43+
required_args.add_argument('--refresh-token',
4244
required=True,
4345
help='VMware Cloud API refresh token')
4446

45-
parser.add_argument('-o', '--org-id',
47+
required_args.add_argument('--org-id',
4648
required=True,
4749
help='Organization identifier.')
4850

49-
parser.add_argument('-s', '--sddc-id',
51+
required_args.add_argument('--sddc-id',
5052
required=True,
51-
help='Sddc Identifier.')
53+
help='SDDC Identifier.')
5254

5355
parser.add_argument('--notes',
5456
default='Sample public IP ' + str(random.randint(0, 100)),
@@ -62,11 +64,11 @@ def __init__(self):
6264
default='Sample NAT rule ' + str(random.randint(0, 100)),
6365
help='Description for the NAT rule')
6466

65-
parser.add_argument('--internal-ip',
67+
required_args.add_argument('--internal-ip',
6668
required=True,
6769
help='Private IP of the VM')
6870

69-
parser.add_argument('-c', '--cleardata',
71+
parser.add_argument('--cleardata',
7072
action='store_true',
7173
help='Clean up after sample run')
7274
args = parser.parse_args()

‎samples/vmc/networks_nsxv/firewall_rules_crud.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,18 @@ class FirewallRulesCrud(object):
3434
def __init__(self):
3535
parser = argparse.ArgumentParser(
3636
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
37-
parser.add_argument(
38-
'-r',
37+
38+
required_args = parser.add_argument_group('required arguments')
39+
required_args.add_argument(
3940
'--refresh-token',
4041
required=True,
4142
help='VMware Cloud API refresh token')
4243

43-
parser.add_argument(
44-
'-o', '--org-id', required=True, help='Organization identifier.')
44+
required_args.add_argument(
45+
'--org-id', required=True, help='Organization identifier.')
4546

46-
parser.add_argument(
47-
'-s', '--sddc-id', required=True, help='Sddc Identifier.')
47+
required_args.add_argument(
48+
'--sddc-id', required=True, help='Sddc Identifier.')
4849

4950
parser.add_argument(
5051
'--rule-name',
@@ -59,7 +60,6 @@ def __init__(self):
5960
'management gateway')
6061

6162
parser.add_argument(
62-
'-c',
6363
'--cleardata',
6464
action='store_true',
6565
help='Clean up after sample run')

‎samples/vmc/networks_nsxv/ipsec_vpns_crud.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,18 @@ class IpsecVPNsCrud(object):
3232
def __init__(self):
3333
parser = argparse.ArgumentParser(
3434
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
35-
parser.add_argument(
36-
'-r',
35+
36+
required_args = parser.add_argument_group('required arguments')
37+
required_args.add_argument(
3738
'--refresh-token',
3839
required=True,
3940
help='VMware Cloud API refresh token')
4041

41-
parser.add_argument(
42-
'-o', '--org-id', required=True, help='Organization identifier.')
42+
required_args.add_argument(
43+
'--org-id', required=True, help='Organization identifier.')
4344

44-
parser.add_argument(
45-
'-s', '--sddc-id', required=True, help='Sddc Identifier.')
45+
required_args.add_argument(
46+
'--sddc-id', required=True, help='SDDC Identifier.')
4647

4748
parser.add_argument(
4849
'--use-compute-gateway',
@@ -82,7 +83,6 @@ def __init__(self):
8283
help='Pre Shared Key for the IPsec Site')
8384

8485
parser.add_argument(
85-
'-c',
8686
'--cleardata',
8787
action='store_true',
8888
help='Clean up after sample run')

0 commit comments

Comments
 (0)