The vmware_nsx.plugins.nsx_v.vshield.vcns Module

class vmware_nsx.plugins.nsx_v.vshield.vcns.Vcns(address, user, password, ca_file, insecure)

Bases: object

add_firewall_rule(edge_id, fwr_req)
add_firewall_rule_above(edge_id, ref_vcns_rule_id, fwr_req)
add_member_to_security_group(*args, **kw)
add_vdr_internal_interface(edge_id, interface)
add_vm_to_exclude_list(vm_id)
approve_assigned_addresses(*args, **kw)
change_edge_appliance(edge_id, request)
change_edge_appliance_size(edge_id, size)

Change the size of edge appliances.

configure_aggregate_publishing()
configure_reservations()
create_app_profile(edge_id, app_profile)
create_app_rule(edge_id, app_rule)
create_bridge(*args, **kw)
create_csr(edge_id, request='<csr><subject><attribute><key>CN</key><value>metadata.nsx.local</value></attribute><attribute><key>O</key><value>Organization</value></attribute><attribute><key>OU</key><value>Unit</value></attribute><attribute><key>L</key><value>Locality</value></attribute><attribute><key>ST</key><value>State</value></attribute><attribute><key>C</key><value>US</value></attribute></subject><algorithm>RSA</algorithm><keySize>2048</keySize></csr>')

Create a CSR on the specified Edge appliance.

create_csr_cert(csr_id)

Create a CSR self signed cert on the specified Edge appliance.

create_dhcp_binding(edge_id, request_config)

Append one dhcp static binding on the edge.

create_health_monitor(edge_id, monitor_new)
create_lswitch(lsconfig)
create_pool(edge_id, pool_new)
create_port_group(dvs_id, request)

Creates a port group on a DVS

The method will return the port group ID.

create_redirect_section(request)

Creates a layer 3 redirect section in nsx rule table.

The method will return the uri to newly created section.

create_section(type, request, insert_top=False, insert_before=None)

Creates a layer 3 or layer 2 section in nsx rule table.

The method will return the uri to newly created section.

create_security_group(request)

Creates a security group container in nsx.

The method will return the security group ID.

create_spoofguard_policy(*args, **kw)
create_vip(edge_id, vip_new)
create_virtual_wire(*args, **kw)
delete_app_profile(edge_id, app_profileid)
delete_app_rule(edge_id, app_ruleid)
delete_bridge(*args, **kw)
delete_dhcp_binding(edge_id, binding_id)

Delete one dhcp static binding on the edge.

delete_edge(edge_id)
delete_firewall(edge_id)
delete_firewall_rule(edge_id, vcns_rule_id)
delete_health_monitor(edge_id, monitor_vseid)
delete_interface(edge_id, vnic_index)
delete_ipsec_config(edge_id)
delete_lswitch(lswitch_id)
delete_nat_rule(edge_id, rule_id)
delete_pool(edge_id, pool_vseid)
delete_port_group(dvs_id, portgroup_id)

Deletes a portgroup.

delete_section(section_uri)

Deletes a section in nsx rule table.

delete_security_group(securitygroup_id)

Deletes a security group container.

delete_spoofguard_policy(*args, **kw)
delete_vdr_internal_interface(*args, **kw)
delete_vip(edge_id, vip_vseid)
delete_virtual_wire(virtualwire_id)

Deletes a virtual wire.

delete_vm_from_exclude_list(vm_id)
deploy_edge(*args, **kw)
do_request(method, uri, params=None, format='json', **kwargs)
edges_lock_operation()
enable_ha(edge_id, request_config)

Enable HA in the given edge.

enable_service_loadbalancer(edge_id, config)
get_dfw_config()
get_edge(edge_id)
get_edge_deploy_status(edge_id)
get_edge_id(job_id)
get_edge_interfaces(edge_id)
get_edge_jobs(edge_id)
get_edge_status(edge_id)
get_edges()
get_firewall(edge_id)
get_firewall_rule(edge_id, vcns_rule_id)
get_health_monitor(edge_id, monitor_vseid)
get_interfaces(edge_id)
get_inventory_name(object_id)
get_ipsec_config(edge_id)
get_loadbalancer_config(edge_id)
get_loadbalancer_statistics(edge_id)
get_nat_config(edge_id)
get_pool(edge_id, pool_vseid)
get_routes(edge_id)
get_scoping_objects()
get_section(section_uri)
get_section_id(section_name)

Retrieve the id of a section from nsx.

get_security_group_id(sg_name)

Returns NSXv security group id which match the given name.

get_service_insertion_profile(profile_id)
get_spoofguard_policies()
get_spoofguard_policy(policy_id)
get_system_control(edge_id)
get_tuning_configration()
get_vdn_switch(dvs_id)
get_vdr_internal_interface(edge_id, interface_index)
get_version()
get_vip(edge_id, vip_vseid)
inactivate_vnic_assigned_addresses(policy_id, vnic_id)
list_security_groups()
publish_assigned_addresses(*args, **kw)
query_dhcp_configuration(edge_id)

Query DHCP configuration from the specific edge.

query_interface(edge_id, vnic_index)
reconfigure_dhcp_service(edge_id, request_config)

Reconfigure dhcp static bindings in the created Edge.

remove_member_from_security_group(security_group_id, member_id)

Removes a vnic member from nsx security group.

remove_rule_from_section(section_uri, rule_id)

Deletes a rule from nsx section table.

set_system_control(edge_id, prop)
update_app_profile(edge_id, app_profileid, app_profile)
update_app_rule(edge_id, app_ruleid, app_rule)
update_edge(edge_id, request)
update_firewall(edge_id, fw_req)
update_firewall_rule(edge_id, vcns_rule_id, fwr_req)
update_health_monitor(edge_id, monitor_vseid, monitor_new)
update_interface(*args, **kw)
update_ipsec_config(edge_id, ipsec_config)
update_nat_config(edge_id, nat)
update_pool(edge_id, pool_vseid, pool_new)
update_routes(edge_id, routes)
update_section(section_uri, request, h)

Replaces a section in nsx rule table.

update_section_by_id(id, type, request)

Update a section while building its uri from the id.

update_security_group(sg_id, sg_name, description)

Updates the NSXv security group name.

update_service_insertion_profile_binding(profile_id, request)
update_spoofguard_policy(*args, **kw)
update_vdn_switch(switch)
update_vdr_internal_interface(edge_id, interface_index, interface)
update_vip(edge_id, vip_vseid, vip_new)
upload_edge_certificate(edge_id, request)

Creates a certificate on the specified Edge appliance.

validate_datacenter_moid(object_id)
validate_dvs(object_id)
validate_inventory(object_id)
validate_network(object_id)
validate_network_name(object_id, name)
validate_vdn_scope(object_id)
vmware_nsx.plugins.nsx_v.vshield.vcns.retry_upon_exception(exc, delay=500, max_delay=4000, max_attempts=20)

Previous topic

The vmware_nsx.plugins.nsx_v.vshield.tasks.tasks Module

Next topic

The vmware_nsx.plugins.nsx_v.vshield.vcns_driver Module

This Page