release notes and some security group things

Author: allmightyspiff

classes/softlayer_network_securitygroup/index.html

@@ -101,8 +101,18 @@ <h3>python</h3>
                         <ul>
 
                             <li>
-                            <a href="https://softlayer.github.io/python/createsecuritygroup/">Create a Security group</a>
-                            <div class="meta">Example for creating a Security Group.</div>
+                            <a href="https://softlayer.github.io/python/securitygroup_rule_ops/">Add, list, and remove security group rules</a>
+                            <div class="meta">Examples for adding, listing, and removing rules from security groups</div>
+                            </li>
+                            
+                            <li>
+                            <a href="https://softlayer.github.io/python/securitygroup_ops/">Create, list, get, and delete security groups</a>
+                            <div class="meta">Examples for creating, listing, getting, and deleting security groups</div>
+                            </li>
+                            
+                            <li>
+                            <a href="https://softlayer.github.io/python/securitygroup_vsis/">VSIs and security groups</a>
+                            <div class="meta">Examples for associating and disassociating VSIs with security groups</div>
                             </li>
 
                         </ul>

classes/softlayer_network_securitygroup/index.xml

@@ -6,7 +6,306 @@
     <language>en-US</language>
     <author>Enthusiastic Hugo User</author>
     <rights>Copyright (c) 2014, Enthusiastic Hugo User; all rights reserved.</rights>
-    <updated>Mon, 02 Oct 2017 00:00:00 UTC</updated>
+    <updated>Wed, 18 Oct 2017 00:00:00 UTC</updated>
+    
+    <item>
+      <title>Add, list, and remove security group rules</title>
+      <link>https://softlayer.github.io/python/securitygroup_rule_ops/</link>
+      <pubDate>Wed, 18 Oct 2017 00:00:00 UTC</pubDate>
+      <author>Enthusiastic Hugo User</author>
+      <guid>https://softlayer.github.io/python/securitygroup_rule_ops/</guid>
+      <description>
+
+&lt;h2 id=&#34;adding-a-rule-to-a-security-group&#34;&gt;Adding a rule to a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+sg_id = 123045
+direction = &#39;ingress&#39;
+ethertype = &#39;IPv4&#39;
+remote_ip = &#39;169.148.34.0/24&#39;
+protocol = &#39;tcp&#39;
+port_min = 22
+port_max = 22
+try:
+    result = net_mgr.add_securitygroup_rule(sg_id,
+                                            direction=direction,
+                                            ethertype=ethertype,
+                                            remote_ip=remote_ip,
+                                            protocol=protocol,
+                                            port_min=port_min,
+                                            port_max=port_max)
+    pp(result)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to add a rule to the security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;listing-rules-in-a-security-group&#34;&gt;Listing rules in a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+sg_id = 123045
+try:
+    result = net_mgr.list_securitygroup_rules(sg_id)
+    pp(result)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to list rules in the security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;removing-a-rule-from-a-security-group&#34;&gt;Removing a rule from a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+sg_id = 123045
+rule_id = 475879
+try:
+    result = net_mgr.remove_securitygroup_rule(sg_id, rule_id)
+    pp(result)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to remove rule from the security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;remove-all-rules-from-a-security-group&#34;&gt;Remove all rules from a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+sg_id = 123045
+try:
+    rules = net_mgr.list_securitygroup_rules(sg_id)
+    rules = [rule[&#39;id&#39;] for rule in rules]
+    result = net_mgr.remove_securitygroup_rules(sg_id, rules)
+    pp(result)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to remove rules from the security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+</description>
+    </item>
+    
+    <item>
+      <title>Create, list, get, and delete security groups</title>
+      <link>https://softlayer.github.io/python/securitygroup_ops/</link>
+      <pubDate>Wed, 18 Oct 2017 00:00:00 UTC</pubDate>
+      <author>Enthusiastic Hugo User</author>
+      <guid>https://softlayer.github.io/python/securitygroup_ops/</guid>
+      <description>
+
+&lt;h2 id=&#34;creating-a-security-group&#34;&gt;Creating a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+name = &#39;pythonCreatedGroupExample&#39;
+description = &#39;Security Group created via python&#39;
+try:
+    result = net_mgr.create_securitygroup(name=name, description=description)
+    pp(result)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to create a new security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;deleting-a-security-group&#34;&gt;Deleting a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+sg_id = 12045
+try:
+    result = net_mgr.delete_securitygroup(sg_id)
+    pp(result)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to delete security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;getting-a-security-group&#34;&gt;Getting a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+sg_id = 12045
+try:
+    result = net_mgr.get_securitygroup(sg_id)
+    pp(result)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to get security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;list-all-security-groups-in-account&#34;&gt;List all security groups in account&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+
+result = net_mgr.list_securitygroups()
+pp(result)
+&lt;/code&gt;&lt;/pre&gt;
+</description>
+    </item>
+    
+    <item>
+      <title>VSIs and security groups</title>
+      <link>https://softlayer.github.io/python/securitygroup_vsis/</link>
+      <pubDate>Wed, 18 Oct 2017 00:00:00 UTC</pubDate>
+      <author>Enthusiastic Hugo User</author>
+      <guid>https://softlayer.github.io/python/securitygroup_vsis/</guid>
+      <description>
+
+&lt;h2 id=&#34;creating-a-vsi-with-security-groups&#34;&gt;Creating a VSI with security groups&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the VSManager
+client = SoftLayer.Client()
+vs_mgr = SoftLayer.VSManager(client)
+
+http_sg_id = 384757
+ssh_sg_id = 576973
+
+# Allow only HTTP on the public interface of the VSI
+public_groups = [http_sg_id]
+
+# Allow HTTP and SSH on the private interface of the VSI
+private_groups = [http_sg_id, ssh_sg_id]
+
+# If we didn&#39;t want to set any security groups on an interface
+# (which allows all traffic), we don&#39;t set the associated
+# creation kwarg
+
+create_kwargs = {
+    &#39;hostname&#39;: &#39;sg-vsi&#39;,
+    &#39;domain&#39;: &#39;mycompany.com&#39;,
+    &#39;os_code&#39;: &#39;UBUNTU_LATEST_64&#39;,
+    &#39;datacenter&#39;: &#39;dal13&#39;,
+    &#39;cpus&#39;: 1,
+    &#39;memory&#39;: 1024,
+    &#39;hourly&#39;: True,
+    &#39;disks&#39;: (&#39;100&#39;,),
+    &#39;public_security_groups&#39;: public_groups,
+    &#39;private_security_groups&#39;: private_groups,
+}
+
+try:
+    vsi = vs_mgr.create_instance(**create_kwargs)
+    pp(vsi)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to create VSI with security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;attach-an-existing-vsi-to-security-groups&#34;&gt;Attach an existing VSI to security groups&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager and VSManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+vs_mgr = SoftLayer.VSManager(client)
+
+http_sg_id = 384757
+vsi_id = 4018735
+private_interface = False
+port_number = 0 if private_interface else 1
+network_component_mask = &#39;networkComponents[id, port]&#39;
+
+try:
+    vsi_components = vs_mgr.get_instance(vsi_id, mask=network_component_mask)
+    component_to_attach = [comp for comp in vsi_components[&#39;networkComponents&#39;]
+                           if comp[&#39;port&#39;] == port_number][0]
+    result = net_mgr.attach_securitygroup_component(http_sg_id,
+                                                    component_to_attach[&#39;id&#39;])
+    pp(result)
+    
+    # If this is the first time the server is being associated with security groups,
+    # a reboot is required for the security group to take effect on the VSI
+    client[&#39;Virtual_Guest&#39;].rebootSoft(id=vsi_id)
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to associate VSI with security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;detach-a-vsi-from-a-security-group&#34;&gt;Detach a VSI from a security group&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
+# For nice debug output
+from pprint import pprint as pp
+
+# Create a client for use with the NetworkManager and VSManager
+client = SoftLayer.Client()
+net_mgr = SoftLayer.NetworkManager(client)
+vs_mgr = SoftLayer.VSManager(client)
+
+http_sg_id = 384757
+vsi_id = 4018735
+private_interface = False
+port_number = 0 if private_interface else 1
+network_component_mask = &#39;networkComponents[id, port]&#39;
+
+try:
+    vsi_components = vs_mgr.get_instance(vsi_id, mask=network_component_mask)
+    component_to_detach = [comp for comp in vsi_components[&#39;networkComponents&#39;]
+                           if comp[&#39;port&#39;] == port_number][0]
+    net_mgr.detach_securitygroup_component(http_sg_id,
+                                           component_to_detach[&#39;id&#39;])
+    
+except SoftLayer.SoftLayerAPIError as e:
+    pp(&#39;Failed... Unable to disassociate VSI with security group: faultCode=%s, faultString=%s&#39;
+       % (e.faultCode, e.faultString))
+&lt;/code&gt;&lt;/pre&gt;
+</description>
+    </item>
 
     <item>
       <title>Add, get, edit and remove Security Group rules</title>
@@ -352,37 +651,6 @@ secGroupId = 70501
 
 getAll = client[&#39;SoftLayer_Network_SecurityGroup&#39;].object_with_id(secGroupId).getAllObjects
 pp getAll
-&lt;/code&gt;&lt;/pre&gt;
-</description>
-    </item>
-    
-    <item>
-      <title>Create a Security group</title>
-      <link>https://softlayer.github.io/python/createsecuritygroup/</link>
-      <pubDate>Tue, 20 Jun 2017 00:00:00 UTC</pubDate>
-      <author>Enthusiastic Hugo User</author>
-      <guid>https://softlayer.github.io/python/createsecuritygroup/</guid>
-      <description>
-
-&lt;h2 id=&#34;creating-a-security-group&#34;&gt;Creating a Security Group&lt;/h2&gt;
-
-&lt;pre&gt;&lt;code class=&#34;language-python&#34;&gt;import SoftLayer
-# For nice debug output:
-from pprint import pprint as pp
-# Create an object template to create the item.
-objectTemplate = {
-	&#39;accountId&#39;: YOUR_ACCOUNT_ID,
-    &#39;name&#39;: &#39;pythonCreatedGroupExample&#39;,
-    &#39;description&#39;: &#39;Sec Group created via python&#39;
-} 
-client = SoftLayer.Client()
-try:
-    result = client[&#39;SoftLayer_Network_SecurityGroup&#39;].createObjects([objectTemplate])
-    pp(result)
-except SoftLayer.SoftLayerAPIError as e:
-    pp(&#39;Failed ... Unable to create a new SecGroup  faultCode=%s, faultString=%s&#39;
-        % (e.faultCode, e.faultString))
-
 &lt;/code&gt;&lt;/pre&gt;
 </description>
     </item>

classes/softlayer_virtual_guest/index.html

@@ -145,6 +145,11 @@ <h3>php</h3>
                         <h3>python</h3>
                         <ul>
 
+                            <li>
+                            <a href="https://softlayer.github.io/python/createvsiwithsecgroup/">Create a new virtual server and attach Security Groups</a>
+                            <div class="meta">Creates a new virtual server (VSI) aand attach the public and private interfaces to respective Security Groups.</div>
+                            </li>
+                            
                             <li>
                             <a href="https://softlayer.github.io/python/migratededicatedinstance/">Migrate a VSI between dedicated hosts</a>
                             <div class="meta">Migrate a Dedicated Host instance to another Dedicated Host. You can migrate your dedicated host instances from one host to another within the same POD.</div>